Cloud

API Access / Reference / REST API

API Token

Postman Collection

OpenAPI

API Token APIs

Operations

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

GET

Get all API tokens in an org

Gets all user API tokens in an organization.

Scopes

OAuth 2.0 scopes required: read:tokens:admin

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>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>"
  }
}

GET

Get API token count in an org

Gets count of user API tokens in an organization.

Scopes

OAuth 2.0 scopes required: read:tokens:admin

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'

DEL

Bulk revoke API tokens in an organization

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

Request

Path parameters

orgId

string

Required

Responses

Successful operation

DEL/v1/orgs/{orgId}/api-tokens

curl

Node.js

Java

Python

PHP

1
2

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