List API tokens - Astronomer

GET

organizations

{organizationId}

tokens

List API tokens

curl --request GET \
  --url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 10,
  "offset": 0,
  "tokens": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "description": "my token description",
      "id": "clm8q7f6q000008lcgyougpsk",
      "kind": "STANDARD",
      "name": "My token",
      "shortToken": "short-token",
      "startAt": "2022-11-22T04:37:12Z",
      "type": "WORKSPACE",
      "updatedAt": "2022-11-22T04:37:12Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "endAt": "2022-11-22T04:37:12Z",
      "expiryPeriodInDays": 30,
      "lastRotatedAt": "2022-11-22T04:37:12Z",
      "lastUsedAt": "2022-11-22T04:37:12Z",
      "roles": [
        {
          "entityId": "clm8sgvai000008l794psbkdv",
          "entityType": "WORKSPACE",
          "role": "WORKSPACE_MEMBER",
          "deploymentId": "clm8t5u4q000008jq4qoc3031"
        }
      ],
      "token": "token",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      }
    }
  ],
  "totalCount": 100
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId

string

required

The ID of the Organization to list tokens for.

Query Parameters

workspaceId

string

The ID of the Workspace to list API tokens for.

deploymentId

string

The ID of the Deployment to list API tokens for.

dagId

string

The ID of the Dag to list API tokens for.

dagTags

string[]

The tags of the Dag to list API tokens for.

includeOnlyOrganizationTokens

boolean

Whether to show only Organization API tokens.

kind

enum<string>

The kind of the API token to list API tokens for.

Available options:

STANDARD,

DIRECT_ACCESS

offset

integer

default:0

Offset for pagination

Required range: x >= 0

limit

integer

default:20

Limit for pagination

Required range: 0 <= x <= 1000

sorts

enum<string>[]

Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'

Available options:

name:asc,

name:desc,

description:asc,

description:desc,

createdAt:asc,

createdAt:desc,

updatedAt:asc,

updatedAt:desc,

tokenStartAt:asc,

tokenStartAt:desc

Response

limit

integer

required

The limit of values in this page.

Example:

10

offset

integer

required

The offset of values in this page.

Example:

0

tokens

object[]

required

The list of API tokens in this page.

Show child attributes

totalCount

integer

required

The total number of API tokens.

Example:

100

⌘I

List API tokens

curl --request GET \
  --url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 10,
  "offset": 0,
  "tokens": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "description": "my token description",
      "id": "clm8q7f6q000008lcgyougpsk",
      "kind": "STANDARD",
      "name": "My token",
      "shortToken": "short-token",
      "startAt": "2022-11-22T04:37:12Z",
      "type": "WORKSPACE",
      "updatedAt": "2022-11-22T04:37:12Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "endAt": "2022-11-22T04:37:12Z",
      "expiryPeriodInDays": 30,
      "lastRotatedAt": "2022-11-22T04:37:12Z",
      "lastUsedAt": "2022-11-22T04:37:12Z",
      "roles": [
        {
          "entityId": "clm8sgvai000008l794psbkdv",
          "entityType": "WORKSPACE",
          "role": "WORKSPACE_MEMBER",
          "deploymentId": "clm8t5u4q000008jq4qoc3031"
        }
      ],
      "token": "token",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      }
    }
  ],
  "totalCount": 100
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}