Create an organization api token

Create an organization api token. You can use the generated token to interact in a programmatic way with our API.

POST /organization/{organizationId}/apiToken

Create an organization api token

cURL

curl --request POST \
  --url https://api.qovery.com/organization/{organizationId}/apiToken \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "scope": "ADMIN"
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "token": "<string>",
  "role_name": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

organizationId · string<uuid> · required

Organization ID

Body

application/json

name · string · required

role_id · string<uuid> | null · required

the roleId provided by the "List organization custom roles" endpoint.

description · string

scope · enum<string> | null

deprecated

Available options: ADMIN

Response

201

application/json

Organization api token created

id · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

updated_at · string<date-time> · read-only

name · string

description · string

token · string

the generated token to send in 'Authorization' header prefixed by 'Token '

role_name · string

role_id · string<uuid>