Sign in

v1

latestOpenAPI 3.0.32026-07-13182371.7 KB
OAuth Client

Create an OAuth client

Creates a new OAuth client for the specified organization.

Note: This is a session-only endpoint and cannot be called with an API token or OAuth 2.0 scope. It requires an active admin session with org management permissions.

Scopes

This endpoint is session-only and does not accept OAuth 2.0 scopes.

post/orgs/{orgId}/oauth-clients

Path parameters

orgIdstring required

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

Request body

namestring required

The display name of the OAuth client.

serviceAccountIdstring required

The Atlassian account ID of the service account to associate with this OAuth client.

Response

Returned if the OAuth client is successfully created.

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

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