OAuth Client

Get an OAuth client

Changed on

Retrieves a specific OAuth client by ID for the specified organization.

Scopes

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

get/orgs/{orgId}/oauth-clients/{clientId}

Request

  • Base URL
    https://api.atlassian.com/admin/api-access/v1
  • URL
    https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/oauth-clients/{clientId}
  • 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.

clientIdstring required

The unique identifier of the OAuth client.

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.

namestring required

The display name of the OAuth client.

createdAtinteger

The timestamp (in milliseconds since epoch) when the OAuth client was created.

updatedAtinteger

The timestamp (in milliseconds since epoch) when the OAuth client was last updated.

status'ACTIVE' | 'REVOKED' | 'EXPIRED' required

The status of the OAuth client.

Example response

{
  "tokenEndpointAuthMethod": "private_key_jwt",
  "createdAt": 1763149545609,
  "updatedAt": 1763149545609
}

Changes