Service Account lifecycle and credential APIs
Retrieves API tokens belonging to service accounts in the specified organization.
OAuth 2.0 scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Returned if the request is successful.
integer
integer
string
array<allOf [ApiToken, object]>
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/api-tokens' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
{
"id": "<string>",
"label": "<string>",
"status": "ALLOWED",
"createdAt": "<string>",
"expiresAt": "<string>",
"lastActiveAt": "<string>",
"user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"scopes": [
"<string>"
]
}
]Retrieves API tokens for a specific service account within an organization.
Authorization scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Returned if the request is successful.
integer
integer
string
array<allOf [ApiToken, object]>
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/{serviceAccountId}/api-tokens' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
{
"id": "<string>",
"label": "<string>",
"status": "ALLOWED",
"createdAt": "<string>",
"expiresAt": "<string>",
"lastActiveAt": "<string>",
"user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"scopes": [
"<string>"
]
}
]Retrieves all service accounts for the specified organization.
OAuth 2.0 scopes required: read:service-accounts: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 GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"links": {
"next": "<string>",
"prev": "<string>"
},
"items": [
{
"atlassianId": "<string>",
"id": "<string>",
"email": "<string>",
"displayName": "<string>",
"picture": "<string>",
"container": "<string>",
"updatedAt": 1764642980899,
"status": "<string>",
"createdById": "<string>",
"description": "<string>"
}
],
"total": 57
}Creates a new service account for the specified organization. The service account is created with the given display name and optional description, then invited with the specified permission rules and optional additional group memberships.
OAuth 2.0 scopes required: write:service-accounts:admin
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe service account creation request.
string
Requiredstring
array<PermissionRule>
Requiredarray<AdditionalGroup>
Returned if the service account is successfully created.
integer
integer
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl --request POST \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"description": "<string>",
"permissionRules": [
{
"resource": "<string>",
"role": "<string>"
}
],
"additionalGroups": [
{
"directoryId": "<string>",
"groupId": "<string>"
}
]
}'1
2
3
4
5
6
7
8
9
{
"atlassianId": "<string>",
"id": "<string>",
"email": "<string>",
"displayName": "<string>",
"container": "<string>",
"updatedAt": 1763149545609,
"status": "<string>"
}Updates a service account's display name and/or description within the specified organization.
OAuth 2.0 scopes required: write:service-accounts:admin
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe service account update request.
string
Requiredstring
string
Returned if the service account is successfully updated.
integer
integer
string
Represents a service account.
1
2
3
4
5
6
7
8
9
curl --request PATCH \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"atlassianId": "<string>",
"displayName": "<string>",
"description": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
{
"atlassianId": "<string>",
"id": "<string>",
"email": "<string>",
"displayName": "<string>",
"picture": "<string>",
"container": "<string>",
"updatedAt": 1764642980899,
"status": "<string>",
"createdById": "<string>",
"description": "<string>"
}Deletes a service account from the specified organization.
OAuth 2.0 scopes required: write:service-accounts:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturned if the service account is successfully deleted.
integer
integer
string
1
2
curl --request DELETE \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/{serviceAccountId}'Retrieves OAuth clients belonging to service accounts in the specified organization.
OAuth 2.0 scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Returned if the request is successful.
integer
integer
string
array<ServiceAccountOAuthClient>
List of OAuth clients for service accounts in the organization.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/oauth-clients' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
[
{
"clientId": "<string>",
"clientName": "<string>",
"serviceAccount": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"appType": "<string>",
"orgId": "<string>",
"userStatus": "<string>"
},
"expiresAt": "<string>",
"createdAt": "<string>",
"createdBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"appType": "<string>",
"orgId": "<string>",
"userStatus": "<string>"
},
"clientRevokerId": "<string>",
"clientRevocationTime": "<string>",
"scopes": [
"<string>"
]
}
]Retrieves OAuth clients belonging to the specified service account.
OAuth 2.0 scopes required: read:service-accounts-tokens:admin
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Returned if the request is successful.
integer
integer
string
array<ServiceAccountOAuthClient>
List of OAuth clients for the service account.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/{serviceAccountId}/oauth-clients' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
[
{
"clientId": "<string>",
"clientName": "<string>",
"serviceAccount": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"appType": "<string>",
"orgId": "<string>",
"userStatus": "<string>"
},
"expiresAt": "<string>",
"createdAt": "<string>",
"createdBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"appType": "<string>",
"orgId": "<string>",
"userStatus": "<string>"
},
"clientRevokerId": "<string>",
"clientRevocationTime": "<string>",
"scopes": [
"<string>"
]
}
]Rate this page: