Access keys

List access keys

List the access keys that are created for this organization.

GET/organizations/{organizationId}/access-keys

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Query parameters

Response

200404

OK

Body

application/json

results*array of AccessKey

List of access keys.

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/access-keys', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "results": [
    {
      "id": "text",
      "organizationId": "text",
      "name": "text",
      "type": "user",
      "description": "text",
      "suffix": "text",
      "lastUsedAt": "2024-04-29T08:27:51.002Z",
      "createdAt": "2024-04-29T08:27:51.002Z",
      "updatedAt": "2024-04-29T08:27:51.002Z",
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create access key

Create a new access key for the organization.

POST/organizations/{organizationId}/access-keys

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

name*AccessKeyName (string)

Access key name.

description*AccessKeyDescription (string)

Access key description.

roleRefsarray of RoleReference

The list of IAM roles to assign to the access key.

Response

201404422

Created

Body

application/json

accessKey*AccessKey

The access key record.

token*string

The token that can be used for authentication

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/access-keys', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text"
    }),
});
const data = await response.json();

Response

{
  "accessKey": {
    "id": "text",
    "organizationId": "text",
    "name": "text",
    "type": "user",
    "description": "text",
    "suffix": "text",
    "lastUsedAt": "2024-04-29T08:27:51.002Z",
    "createdAt": "2024-04-29T08:27:51.002Z",
    "updatedAt": "2024-04-29T08:27:51.002Z",
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ]
  },
  "token": "text"
}

Get access key

Retrieve a single access key.

GET/organizations/{organizationId}/access-keys/{accessKeyId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

accessKeyId*string

ID for an access key

Response

200404

OK

Body

application/json

id*string (uuid)

ID of the access key.

organizationId*string (uuid)

ID of the organization that owns the access key.

name*AccessKeyName (string)

Access key name.

typeAccessKeyType (enum)

userservice

descriptionAccessKeyDescription (string)

Access key description.

suffix*AccessKeySuffix (string)

Access key suffix.

lastUsedAtnullable string (date-time)

When the access key was last used.

createdAt*string (date-time)

When the access key was created.

updatedAtstring (date-time)

When the access key was last updated.

roles*array of Role

IAM roles attached to this access key.

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/access-keys/{accessKeyId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "type": "user",
  "description": "text",
  "suffix": "text",
  "lastUsedAt": "2024-04-29T08:27:51.002Z",
  "createdAt": "2024-04-29T08:27:51.002Z",
  "updatedAt": "2024-04-29T08:27:51.002Z",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "type": "organization",
      "policies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "definitions": [
            {
              "effect": "allow",
              "resources": [
                "text"
              ],
              "actions": [
                "any"
              ],
              "conditionsAll": [
                {}
              ]
            }
          ],
          "scope": "organization",
          "type": "managed",
          "createdAt": "2024-04-29T08:27:51.002Z",
          "updatedAt": "2024-04-29T08:27:51.002Z"
        }
      ],
      "createdAt": "2024-04-29T08:27:51.002Z",
      "updatedAt": "2024-04-29T08:27:51.002Z"
    }
  ]
}

Delete access key

Remove the access key from the organization.

DELETE/organizations/{organizationId}/access-keys/{accessKeyId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

accessKeyId*string

ID for an access key

Response

204404

OK

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/access-keys/{accessKeyId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Update access key

Update the access key's properties.

PATCH/organizations/{organizationId}/access-keys/{accessKeyId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

accessKeyId*string

ID for an access key

Body

application/json

nameAccessKeyName (string)

Access key name.

descriptionAccessKeyDescription (string)

Access key description.

roleRefsarray of RoleReference

The list of IAM roles to assign to the access key.

Response

200404422500

OK

Body

application/json

id*string

ID of the access key.

organizationId*string

ID of the organization that owns the access key.

name*AccessKeyName (string)

Access key name.

typeAccessKeyType (enum)

userservice

descriptionAccessKeyDescription (string)

Access key description.

suffix*AccessKeySuffix (string)

Access key suffix.

lastUsedAtnullable string (date-time)

When the access key was last used.

createdAt*string (date-time)

When the access key was created.

updatedAtstring (date-time)

When the access key was last updated.

roleRefsarray of RoleReference

The list of IAM roles assigned to the access key.

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/access-keys/{accessKeyId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "organizationId": "text",
  "name": "text",
  "type": "user",
  "description": "text",
  "suffix": "text",
  "lastUsedAt": "2024-04-29T08:27:51.002Z",
  "createdAt": "2024-04-29T08:27:51.002Z",
  "updatedAt": "2024-04-29T08:27:51.002Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}