Access keys

Last updated 1 year ago

Was this helpful?

Get access key

get

Retrieve a single access key.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

accessKeyIdstringrequired

ID for an access key

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/access-keys/{accessKeyId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "type": "user",
  "description": "text",
  "suffix": "text",
  "lastUsedAt": "2025-03-28T18:52:12.097Z",
  "createdAt": "2025-03-28T18:52:12.097Z",
  "updatedAt": "2025-03-28T18:52:12.097Z",
  "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": [
                {
                  "any": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                }
              ]
            }
          ],
          "rolesDependencyCount": 1,
          "usersDependencyCount": 1,
          "scope": "organization",
          "type": "managed",
          "createdAt": "2025-03-28T18:52:12.097Z",
          "updatedAt": "2025-03-28T18:52:12.097Z",
          "metadata": {
            "clouds": [
              "platform"
            ],
            "apps": [
              "inbox"
            ],
            "groups": [
              "text"
            ]
          }
        }
      ],
      "usersDependencyCount": 1,
      "accessKeysDependencyCount": 1,
      "createdAt": "2025-03-28T18:52:12.097Z",
      "updatedAt": "2025-03-28T18:52:12.097Z",
      "metadata": {
        "clouds": [
          "platform"
        ]
      },
      "actions": [
        {
          "name": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Delete access key

delete

Remove the access key from the organization.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

accessKeyIdstringrequired

ID for an access key

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/access-keys/{accessKeyId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

List access keys

get

List the access keys that are created for this organization.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

pageTokenstringoptional

Pagination token that keeps of track of the current position in the list

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/access-keys' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "organizationId": "text",
      "name": "text",
      "type": "user",
      "description": "text",
      "suffix": "text",
      "lastUsedAt": "2025-03-28T18:52:12.097Z",
      "createdAt": "2025-03-28T18:52:12.097Z",
      "updatedAt": "2025-03-28T18:52:12.097Z",
      "roleIds": [
        "text"
      ],
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create access key

post

Create a new access key for the organization.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

namestring · min: 1 · max: 256required

Access key name.

descriptionstring · min: 1 · max: 256required

Access key description.

roleIdsstring · uuid[] · min: 1 · max: 5optionalDeprecated

IAM roles attached to this access key.

roleRefsobject[] · min: 1 · max: 5optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/access-keys' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "roleIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ]
  }'

201

404

422

{
  "accessKey": {
    "id": "text",
    "organizationId": "text",
    "name": "text",
    "type": "user",
    "description": "text",
    "suffix": "text",
    "lastUsedAt": "2025-03-28T18:52:12.097Z",
    "createdAt": "2025-03-28T18:52:12.097Z",
    "updatedAt": "2025-03-28T18:52:12.097Z",
    "roleIds": [
      "text"
    ],
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ]
  },
  "token": "text"
}

Created

Update access key

patch

Update the access key's properties.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

accessKeyIdstringrequired

ID for an access key

Body

namestring · min: 1 · max: 256optional

Access key name.

descriptionstring · min: 1 · max: 256optional

Access key description.

roleIdsstring · uuid[] · min: 1 · max: 5optionalDeprecated

IAM roles attached to this access key.

roleRefsobject[] · min: 1 · max: 5optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/access-keys/{accessKeyId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "roleIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ]
  }'

200

404

422

500

{
  "id": "text",
  "organizationId": "text",
  "name": "text",
  "type": "user",
  "description": "text",
  "suffix": "text",
  "lastUsedAt": "2025-03-28T18:52:12.097Z",
  "createdAt": "2025-03-28T18:52:12.097Z",
  "updatedAt": "2025-03-28T18:52:12.097Z",
  "roleIds": [
    "text"
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Get access key

Delete access key

List access keys

Create access key

Show child attributes

Update access key

Show child attributes