Retrieves all OAuth clients for the specified organization.
OAuth 2.0 scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
string
Returned if the request is successful.
integer
integer
string
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/oauth-clients' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"data": [
{
"clientId": "<string>",
"name": "<string>",
"createdAt": 1763149545609,
"updatedAt": 1763149545609,
"status": "ACTIVE"
}
],
"links": {
"self": "<string>",
"next": "<string>",
"prev": "<string>"
}
}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.
This endpoint is session-only and does not accept OAuth 2.0 scopes.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredDetails to create an OAuth client
string
Requiredstring
RequiredReturned if the OAuth client is successfully created.
integer
integer
string
Represents an OAuth client associated with an organization.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/oauth-clients' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"serviceAccountId": "<string>"
}'1
2
3
4
5
6
7
{
"clientId": "<string>",
"name": "<string>",
"createdAt": 1763149545609,
"updatedAt": 1763149545609,
"status": "ACTIVE"
}Gets the count of OAuth clients in the specified organization.
OAuth 2.0 scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredReturned if the request is successful.
integer
integer
string
1
2
3
curl --request POST \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/oauth-clients/count' \
--header 'Accept: application/json'1
2
3
{
"total": 53
}Retrieves a specific OAuth client by ID for the specified organization.
OAuth 2.0 scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturned if the request is successful.
integer
integer
string
Represents an OAuth client associated with an organization.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/oauth-clients/{clientId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"clientId": "<string>",
"name": "<string>",
"createdAt": 1763149545609,
"updatedAt": 1763149545609,
"status": "ACTIVE"
}Deletes an existing OAuth client from the specified organization.
OAuth 2.0 scopes required: delete:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturned if the OAuth client is successfully deleted.
integer
integer
string
1
2
curl --request DELETE \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/oauth-clients/{clientId}'Rate this page: