ApiToken

List API tokens

GET

List information about all API tokens from an Organization. Filters on Workspace when Workspace ID is provided. When includeOnlyOrganizationTokens is true, only Organization API tokens are returned.

Path parameters

organizationIdstringRequired
The ID of the Organization to list tokens for.

Query parameters

workspaceIdstringOptional
The ID of the Workspace to list API tokens for.
deploymentIdstringOptional
The ID of the Deployment to list API tokens for.
includeOnlyOrganizationTokensbooleanOptional
Whether to show only Organization API tokens.
offsetintegerOptional
Offset for pagination
limitintegerOptional
Limit for pagination
sortsenumOptional
Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'

Response

This endpoint returns an object
limit
integer
The limit of values in this page.
offset
integer
The offset of values in this page.
tokens
list of objects
The list of API tokens in this page.
totalCount
integer
The total number of API tokens.
GET
1curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "limit": 10,
3  "offset": 0,
4  "tokens": [
5    {
6      "createdAt": "2022-11-22T04:37:12Z",
7      "description": "my token description",
8      "id": "clm8q7f6q000008lcgyougpsk",
9      "name": "My token",
10      "shortToken": "short-token",
11      "startAt": "2022-11-22T04:37:12Z",
12      "type": "DEPLOYMENT",
13      "updatedAt": "2022-11-22T04:37:12Z",
14      "createdBy": {
15        "id": "clm8qv74h000008mlf08scq7k",
16        "apiTokenName": "my-token",
17        "avatarUrl": "https://avatar.url",
18        "fullName": "Jane Doe",
19        "username": "user1@company.com"
20      },
21      "endAt": "2022-11-22T04:37:12Z",
22      "expiryPeriodInDays": 30,
23      "lastUsedAt": "2022-11-22T04:37:12Z",
24      "roles": [
25        {
26          "entityId": "clm8sgvai000008l794psbkdv",
27          "entityType": "DEPLOYMENT",
28          "role": "WORKSPACE_MEMBER"
29        }
30      ],
31      "token": "token",
32      "updatedBy": {
33        "id": "clm8qv74h000008mlf08scq7k",
34        "apiTokenName": "my-token",
35        "avatarUrl": "https://avatar.url",
36        "fullName": "Jane Doe",
37        "username": "user1@company.com"
38      }
39    }
40  ],
41  "totalCount": 100
42}
Built with