Access keys

Last updated 1 year ago

Was this helpful?

List access keys

List the access keys that are created for this organization.

get

/organizations/{organizationId}/access-keys

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

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

Limits the number of results to return

pageTokenstring

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

reverseboolean

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-02-21T18:21:49.421Z",
      "createdAt": "2025-02-21T18:21:49.421Z",
      "updatedAt": "2025-02-21T18:21:49.421Z",
      "roleIds": [
        "text"
      ],
      "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

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[]Deprecated

IAM roles attached to this access key.

roleRefsRoleReference[]

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":[null],"roleRefs":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"organization","workspaces":[null]}]}'

201

404

422

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

Created

Get access key

Retrieve a single access key.

get

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

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-02-21T18:21:49.421Z",
  "createdAt": "2025-02-21T18:21:49.421Z",
  "updatedAt": "2025-02-21T18:21:49.421Z",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "usersDependencyCount": 1,
      "accessKeysDependencyCount": 1,
      "createdAt": "2025-02-21T18:21:49.421Z",
      "updatedAt": "2025-02-21T18:21:49.421Z",
      "type": "organization",
      "actions": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "metadata": {
        "clouds": [
          "platform"
        ]
      },
      "policies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "rolesDependencyCount": 1,
          "usersDependencyCount": 1,
          "createdAt": "2025-02-21T18:21:49.421Z",
          "updatedAt": "2025-02-21T18:21:49.421Z",
          "scope": "organization",
          "type": "managed",
          "metadata": {
            "clouds": [
              "platform"
            ],
            "apps": [
              "inbox"
            ],
            "groups": [
              "text"
            ]
          },
          "definitions": [
            {
              "effect": "allow",
              "resources": [
                "text"
              ],
              "actions": [
                "any"
              ],
              "conditionsAll": [
                {
                  "any": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Delete access key

Remove the access key from the organization.

delete

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

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

Update access key

Update the access key's properties.

patch

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

accessKeyIdstringrequired

ID for an access key

Body

namestring · min: 1 · max: 256

Access key name.

descriptionstring · min: 1 · max: 256

Access key description.

roleIdsstring · uuid[]Deprecated

IAM roles attached to this access key.

roleRefsRoleReference[]

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 '{"roleIds":[null],"roleRefs":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"organization","workspaces":[null]}]}'

200

404

422

500

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