Create an API token - Astronomer

POST

organizations

{organizationId}

tokens

Create an API token

curl --request POST \
  --url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My token",
  "role": "WORKSPACE_OWNER",
  "type": "WORKSPACE",
  "description": "This is my API token",
  "entityId": "clm8pxjjw000008l23jm08hyu",
  "kind": "STANDARD",
  "tokenExpiryPeriodInDays": 30
}
'

import requests

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

payload = {
    "name": "My token",
    "role": "WORKSPACE_OWNER",
    "type": "WORKSPACE",
    "description": "This is my API token",
    "entityId": "clm8pxjjw000008l23jm08hyu",
    "kind": "STANDARD",
    "tokenExpiryPeriodInDays": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My token',
    role: 'WORKSPACE_OWNER',
    type: 'WORKSPACE',
    description: 'This is my API token',
    entityId: 'clm8pxjjw000008l23jm08hyu',
    kind: 'STANDARD',
    tokenExpiryPeriodInDays: 30
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My token',
    'role' => 'WORKSPACE_OWNER',
    'type' => 'WORKSPACE',
    'description' => 'This is my API token',
    'entityId' => 'clm8pxjjw000008l23jm08hyu',
    'kind' => 'STANDARD',
    'tokenExpiryPeriodInDays' => 30
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"My token\",\n  \"role\": \"WORKSPACE_OWNER\",\n  \"type\": \"WORKSPACE\",\n  \"description\": \"This is my API token\",\n  \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n  \"kind\": \"STANDARD\",\n  \"tokenExpiryPeriodInDays\": 30\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My token\",\n  \"role\": \"WORKSPACE_OWNER\",\n  \"type\": \"WORKSPACE\",\n  \"description\": \"This is my API token\",\n  \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n  \"kind\": \"STANDARD\",\n  \"tokenExpiryPeriodInDays\": 30\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My token\",\n  \"role\": \"WORKSPACE_OWNER\",\n  \"type\": \"WORKSPACE\",\n  \"description\": \"This is my API token\",\n  \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n  \"kind\": \"STANDARD\",\n  \"tokenExpiryPeriodInDays\": 30\n}"

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

{
  "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"
  }
}

{
  "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 where you want to create the token.

Body

application/json

The Request body for creating an API token

name

string

required

The name of the API token.

Example:

"My token"

role

string

required

The role of the API token.

Example:

"WORKSPACE_OWNER"

type

enum<string>

required

The scope of the API token.

Available options:

DEPLOYMENT,

WORKSPACE,

ORGANIZATION

Example:

"WORKSPACE"

description

string

The description for the API token.

Example:

"This is my API token"

entityId

string

The ID of the Workspace or Deployment to which the API token is scoped. It is required if Type is WORKSPACE or DEPLOYMENT.

Example:

"clm8pxjjw000008l23jm08hyu"

kind

enum<string>

The kind of API token. Defaults to STANDARD if not specified.

Available options:

STANDARD,

DIRECT_ACCESS

Example:

"STANDARD"

tokenExpiryPeriodInDays

integer

The expiry period of the API token in days. If not specified, the token will never expire.

Required range: 1 <= x <= 3650

Example:

30

Response

createdAt

string<date-time>

required

The time when the API token was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

description

string

required

The description of the API token.

Example:

"my token description"

string

required

The API token's ID.

Example:

"clm8q7f6q000008lcgyougpsk"

kind

enum<string>

required

The kind of the API token.

Available options:

STANDARD,

DIRECT_ACCESS

Example:

"STANDARD"

name

string

required

The name of the API token.

Example:

"My token"

shortToken

string

required

The short value of the API token.

Example:

"short-token"

startAt

string<date-time>

required

The time when the API token will become valid in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

type

enum<string>

required

The type of the API token.

Available options:

DEPLOYMENT,

WORKSPACE,

ORGANIZATION

Example:

"WORKSPACE"

updatedAt

string<date-time>

required

The time when the API token was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

createdBy

object

Show child attributes

endAt

string<date-time>

The time when the API token expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

expiryPeriodInDays

integer

The expiry period of the API token in days.

Example:

30

lastRotatedAt

string<date-time>

The time when the API token was last rotated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

lastUsedAt

string<date-time>

The time when the API token was last used in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

roles

object[]

The roles of the API token.

Show child attributes

token

string

The value of the API token.

Example:

"token"

updatedBy

object

Show child attributes

⌘I

Create an API token

curl --request POST \
  --url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My token",
  "role": "WORKSPACE_OWNER",
  "type": "WORKSPACE",
  "description": "This is my API token",
  "entityId": "clm8pxjjw000008l23jm08hyu",
  "kind": "STANDARD",
  "tokenExpiryPeriodInDays": 30
}
'

import requests

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

payload = {
    "name": "My token",
    "role": "WORKSPACE_OWNER",
    "type": "WORKSPACE",
    "description": "This is my API token",
    "entityId": "clm8pxjjw000008l23jm08hyu",
    "kind": "STANDARD",
    "tokenExpiryPeriodInDays": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My token',
    role: 'WORKSPACE_OWNER',
    type: 'WORKSPACE',
    description: 'This is my API token',
    entityId: 'clm8pxjjw000008l23jm08hyu',
    kind: 'STANDARD',
    tokenExpiryPeriodInDays: 30
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My token',
    'role' => 'WORKSPACE_OWNER',
    'type' => 'WORKSPACE',
    'description' => 'This is my API token',
    'entityId' => 'clm8pxjjw000008l23jm08hyu',
    'kind' => 'STANDARD',
    'tokenExpiryPeriodInDays' => 30
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"My token\",\n  \"role\": \"WORKSPACE_OWNER\",\n  \"type\": \"WORKSPACE\",\n  \"description\": \"This is my API token\",\n  \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n  \"kind\": \"STANDARD\",\n  \"tokenExpiryPeriodInDays\": 30\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/tokens")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My token\",\n  \"role\": \"WORKSPACE_OWNER\",\n  \"type\": \"WORKSPACE\",\n  \"description\": \"This is my API token\",\n  \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n  \"kind\": \"STANDARD\",\n  \"tokenExpiryPeriodInDays\": 30\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My token\",\n  \"role\": \"WORKSPACE_OWNER\",\n  \"type\": \"WORKSPACE\",\n  \"description\": \"This is my API token\",\n  \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n  \"kind\": \"STANDARD\",\n  \"tokenExpiryPeriodInDays\": 30\n}"

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

{
  "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"
  }
}

{
  "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>"
    }
  ]
}