JetBrains Space Help

Applications

Create application

post /api/http/applications

Rights, that may be checked: Create application

Request arguments

object with fields:

  • name: string Required

  • pictureAttachmentId: string ( Nullable and Optional , defaults to null)

  • defaultExternalPicture: string ( Nullable and Optional , defaults to null)

  • clientId: string ( Nullable and Optional , defaults to null)

  • clientSecret: string ( Nullable and Optional , defaults to null)

  • clientCredentialsFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowRedirectURIs: string ( Nullable and Optional , defaults to null)

  • pkceRequired: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowRedirectURIs: string ( Nullable and Optional , defaults to null)

  • endpointUri: string ( Nullable and Optional , defaults to null)

  • endpointSslVerification: boolean ( Optional , defaults to true)

  • appLevelAuth: EndpointAuthCreate ( Nullable and Optional , defaults to null)

  • sslKeystoreAuth: string ( Nullable and Optional , defaults to null)

  • hasVerificationToken: boolean ( Nullable and Optional , defaults to null)

  • hasSigningKey: boolean ( Nullable and Optional , defaults to null)

  • hasPublicKeySignature: boolean ( Nullable and Optional , defaults to null)

  • basicAuthUsername: string ( Nullable and Optional , defaults to null)

  • basicAuthPassword: string ( Nullable and Optional , defaults to null)

  • bearerAuthToken: string ( Nullable and Optional , defaults to null)

  • connectToSpace: boolean ( Nullable and Optional , defaults to false)

  • state: string ( Nullable and Optional , defaults to null)

Response

ES_App

Get all applications (deprecated)

get /api/http/applications

Rights, that may be checked: View application

Request arguments

query: string (Query) Required

withArchived: boolean (Query) ( Optional , defaults to false)

Response

array of ES_App

Refresh menu

post /api/http/applications/refresh-menu

Request arguments

object with fields:

  • appId: string ( Nullable and Optional , defaults to null)

Response

No arguments

Restore application

post /api/http/applications/{application}/restore

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

No arguments

Get all applications

get /api/http/applications/paged

Rights, that may be checked: View application

Request arguments

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

name: string (Query) ( Nullable and Optional , defaults to null)

owner: array of ProfileIdentifier (Query) ( Nullable and Optional , defaults to null)

withArchived: boolean (Query) ( Nullable and Optional , defaults to false)

ordering: AppsOrdering (Query) ( Nullable and Optional , defaults to null)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ES_App Required

Get application

get /api/http/applications/{application}

Rights, that may be checked: View application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

ES_App

Update application

patch /api/http/applications/{application}

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

object with fields:

  • name: string ( Nullable and Optional , defaults to null)

  • pictureAttachmentId: string ( Nullable and Optional )

  • defaultExternalPicture: string ( Nullable and Optional )

  • clientSecret: string ( Nullable and Optional , defaults to null)

  • clientCredentialsFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowRedirectURIs: string ( Nullable and Optional )

  • pkceRequired: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowRedirectURIs: string ( Nullable and Optional )

  • endpointUri: string ( Nullable and Optional )

  • endpointSslVerification: boolean ( Optional )

  • hasVerificationToken: boolean ( Optional )

  • hasPublicKeySignature: boolean ( Optional )

  • hasSigningKey: boolean ( Optional )

  • appLevelAuth: EndpointAppLevelAuthUpdateType ( Optional )

  • sslKeystoreAuth: string ( Nullable and Optional )

  • basicAuthUsername: string ( Optional )

  • basicAuthPassword: string ( Optional )

  • bearerAuthToken: string ( Optional )

Response

ES_App

Delete application

delete /api/http/applications/{application}

Rights, that may be checked: Delete application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

No arguments

Bearer token

get /api/http/applications/{application}/bearer-token

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

string

Get last client credentials access info

get /api/http/applications/{application}/last-client-credentials-access

Rights, that may be checked: View application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

AccessRecord

Latest message deliveries

get /api/http/applications/{application}/latest-messages-deliveries

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of AppMessageDeliveryDTO Required

Public keys

get /api/http/applications/{application}/public-keys

Returns list of public keys in JWKS format. If message signature is successfully verified with any of the returned public keys, the message can be considered authentic.

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

string

Get applications authorized in context

get /api/http/applications/authorizations/authorized-applications

List applications authorized in specified context

Rights, that may be checked: View application

Request arguments

contextIdentifier: string in one of the formats

(Query) Required

Response

array of ES_App

Get all authorized contexts

get /api/http/applications/{application}/authorizations/authorized-contexts

List authorized contexts of an application

Rights, that may be checked: View application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

array of PermissionContextApi

Get all authorized rights

get /api/http/applications/{application}/authorizations/authorized-rights

List authorized rights of an application in specified context

Rights, that may be checked: View application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

contextIdentifier: string in one of the formats

(Query) Required

Response

array of RightDTO

Update authorized right

patch /api/http/applications/{application}/authorizations/authorized-rights

Generic method for editing authorized right status in given context.

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

object with fields:

Response

No arguments

Delete authorized right

delete /api/http/applications/{application}/authorizations/authorized-rights

Remove application authorization in specified context

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

contextIdentifier: string in one of the formats

(Query) Required

Response

No arguments

Request rights

patch /api/http/applications/{application}/authorizations/authorized-rights/request-rights

Request rights for an application in specified context

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

object with fields:

Response

No arguments

Get all required rights

get /api/http/applications/{application}/authorizations/required-rights

List required permissions for an application

Rights, that may be checked: View application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

array of RightDTO

Update required right

patch /api/http/applications/{application}/authorizations/required-rights

Update list of required permissions for an application

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

object with fields:

  • rightCodesToAdd: array of string Required

  • rightCodesToRemove: array of string Required

  • requestRightsInAuthorizedContexts: boolean Required

Response

No arguments

Regenerate app secret

post /api/http/applications/{application}/client-secret/regenerate

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

No arguments

Get client secret

get /api/http/applications/{application}/client-secret

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

string

Create permanent token

post /api/http/applications/{application}/permanent-tokens

Create a permanent token for the given application that can be used to access the current organisation

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

object with fields:

  • name: string Required

  • scope: string Required

  • expires: string (format: date-time) ( Nullable and Optional , defaults to null)

Response

object with fields:

Get all permanent tokens

get /api/http/applications/{application}/permanent-tokens

Get permanent tokens used to access the current organisation by the given application

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

Update permanent token

patch /api/http/applications/{application}/permanent-tokens/{tokenId}

Update an existing personal token used to access the current organisation. The permanent token's name and/or scope can be updated.

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

tokenId: string (Path) Required

object with fields:

  • name: string ( Nullable and Optional , defaults to null)

  • scope: string ( Nullable and Optional , defaults to null)

  • expires: string (format: date-time) ( Nullable and Optional )

Response

No arguments

Delete permanent token

delete /api/http/applications/{application}/permanent-tokens/{tokenId}

Delete a personal token used to access the current organisation

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

tokenId: string (Path) Required

Response

No arguments

Delete current permanent token

delete /api/http/applications/{application}/permanent-tokens/current

Delete personal token of the given application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

No arguments

Regenerate signing key

post /api/http/applications/{application}/signing-key/regenerate

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

No arguments

Get signing key

get /api/http/applications/{application}/signing-key

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

string

Add ssh key

post /api/http/applications/{application}/ssh-keys

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

object with fields:

  • publicKey: string Required

  • comment: string Required

Response

No arguments

Get ssh keys

get /api/http/applications/{application}/ssh-keys

Rights, that may be checked: View application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

array of ES_SshKey

Delete ssh key

delete /api/http/applications/{application}/ssh-keys/{fingerprint}

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

fingerprint: string (Path) Required

Response

No arguments

Regenerate verification token

post /api/http/applications/{application}/verification-token/regenerate

Rights, that may be checked: Edit application

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

No arguments

Get verification token

get /api/http/applications/{application}/verification-token

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

  • clientId: string

  • id: string

  • me

(Path) Required

Response

string

Last modified: 27 May 2022
Administration Auth Modules