ATatlassian
Service Account
OAuth Client

Get OAuth clients for a service account

Changed on

Retrieves OAuth clients belonging to the specified service account.

Scopes

OAuth 2.0 scopes required: read:service-accounts-tokens:admin

get/orgs/{orgId}/service-accounts/{serviceAccountId}/oauth-clients

Request

  • Base URL
    https://api.atlassian.com/admin/api-access/v1
  • URL
    https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/{serviceAccountId}/oauth-clients
  • Auth
    none declared

Path parameters

orgIdstring required

Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.

serviceAccountIdstring required

ID for the service account whose OAuth clients you want to retrieve.

Query parameters

clientNamestring

Optional filter to search for OAuth clients by name.

Response

Returned if the request is successful.

tokenEndpointAuthMethodstring nullable

The token endpoint authentication method, for example post or private_key_jwt. Null for legacy clients whose authentication method has not yet been populated. Read responses do not include public keys, keyId, or clientSecret.

clientIdstring required

The unique identifier of the OAuth client.

clientNamestring required

The display name of the OAuth client.

expiresAtstring date-time nullable

An ISO-8601 formatted timestamp representing when the OAuth client expires.

createdAtstring date-time nullable

An ISO-8601 formatted timestamp representing when the OAuth client was created.

clientRevokerIdstring nullable

The ID of the user that revoked the OAuth client.

clientRevocationTimestring date-time nullable

An ISO-8601 formatted timestamp representing when the OAuth client was revoked.

scopesstring[] required

Array of scopes associated with the OAuth client.

Example response

[
  {
    "tokenEndpointAuthMethod": "private_key_jwt"
  }
]

Changes