Developer

Documentation

Resources

News and Updates

Get Support

Developer

Get Support

DOCUMENTATION

Cloud

Data Center

Resources

News and Updates

Get support

Developer

DOCUMENTATION

Cloud

Data Center

Resources

News and Updates

Get support

Cloud

API Access / Reference / REST API

API Token

Postman Collection

OpenAPI

API Token APIs

Operations

GET/orgs/{orgId}/api-tokens DEL/orgs/{orgId}/api-tokens GET/orgs/{orgId}/api-tokens/count POST/orgs/{orgId}/service-accounts/count DEL/orgs/{orgId}/service-accounts/{serviceAccountId}/api-tokens

GET

Get all API tokens in an org

Gets all user API tokens in an organization.

Scopes

Authorization scopes required: read:tokens:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required

Query parameters

string

status

string

createdAtSearchType

string

createdAtUom

string

createdAtValue

integer

createdAtFrom

string

createdAtTo

string

createdAtRangeFrom

string

createdAtRangeTo

string

lastActiveAtSearchType

string

Responses

Returned if the request is successful.

Headers

X-RateLimit-Limit

integer

X-RateLimit-Remaining

integer

X-RateLimit-Reset

string

application/json

ApiTokenSearchResponse

GET/orgs/{orgId}/api-tokens

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/api-tokens' \
  --header 'Accept: application/json'

200Response

{
  "data": [
    {
      "id": "<string>",
      "label": "<string>",
      "status": "ALLOWED",
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "lastActiveAt": "<string>",
      "user": {
        "id": "<string>",
        "orgId": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "scopes": [
        "<string>"
      ]
    }
  ],
  "links": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>"
  }
}

DEL

Bulk revoke API tokens in an organization

Revokes all managed user API tokens in an organization by orgID.

Scopes

Authorization scopes required: delete:tokens:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required

Responses

Successful operation

DEL/orgs/{orgId}/api-tokens

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/api-tokens'

GET

Get API token count in an org

Gets count of user API tokens in an organization.

Scopes

Authorization scopes required: read:tokens:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required

Query parameters

string

status

string

createdAtSearchType

string

createdAtUom

string

createdAtValue

integer

createdAtFrom

string

createdAtTo

string

createdAtRangeFrom

string

createdAtRangeTo

string

lastActiveAtSearchType

string

Responses

Returned if the request is successful.

Headers

X-RateLimit-Limit

integer

X-RateLimit-Remaining

integer

X-RateLimit-Reset

string

application/json

integer

GET/orgs/{orgId}/api-tokens/count

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/api-tokens/count' \
  --header 'Accept: application/json'

POST

Get service account API token count in an org

Gets count of API tokens for specified service accounts within an organization.

Scopes

Authorization scopes required: read:service-accounts-tokens:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

List of service account IDs to count API tokens for

array<string>

Max items: 100

Responses

Returned if the request is successful.

Headers

X-RateLimit-Limit

integer

X-RateLimit-Remaining

integer

X-RateLimit-Reset

string

application/json

ServiceAccountCredentialCountResponse

POST/orgs/{orgId}/service-accounts/count

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/count' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

200Response

{
  "validServiceAccountIds": [
    {
      "serviceAccountId": "<string>",
      "credentialsCount": 49
    }
  ],
  "invalidServiceAccountIds": [
    "<string>"
  ]
}

DEL

Revoke all API tokens for a service account

Revokes all API tokens for a specific service account within an organization.

Scopes

Authorization scopes required: delete:service-accounts-tokens:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required

serviceAccountId

string

Required

Responses

Returned if the request is successful.

Headers

X-RateLimit-Limit

integer

X-RateLimit-Remaining

integer

X-RateLimit-Reset

string

DEL/orgs/{orgId}/service-accounts/{serviceAccountId}/api-tokens

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts/{serviceAccountId}/api-tokens'