Access keys

List access keys

get

List the access keys that are created for this organization.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstringOptional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

404

Resource not found

application/json

get

/organizations/{organizationId}/access-keys

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/access-keys HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "text",
      "organizationId": "text",
      "name": "text",
      "type": "user",
      "description": "text",
      "suffix": "text",
      "lastUsedAt": "2025-12-16T21:23:00.050Z",
      "createdAt": "2025-12-16T21:23:00.050Z",
      "updatedAt": "2025-12-16T21:23:00.050Z",
      "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

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

Body

application/json

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.

Responses

201

Created

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

post

/organizations/{organizationId}/access-keys

HTTPcURLJavaScriptPython

POST /organizations/{organizationId}/access-keys HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "name": "text",
  "description": "text",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

{
  "accessKey": {
    "id": "text",
    "organizationId": "text",
    "name": "text",
    "type": "user",
    "description": "text",
    "suffix": "text",
    "lastUsedAt": "2025-12-16T21:23:00.050Z",
    "createdAt": "2025-12-16T21:23:00.050Z",
    "updatedAt": "2025-12-16T21:23:00.050Z",
    "roleRefs": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "organization",
        "workspaces": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ]
  },
  "token": "text"
}

Get access key

get

Retrieve a single access key.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

accessKeyIdstringRequired

ID for an access key

Responses

200

OK

application/json

404

Resource not found

application/json

get

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

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "type": "user",
  "description": "text",
  "suffix": "text",
  "lastUsedAt": "2025-12-16T21:23:00.050Z",
  "createdAt": "2025-12-16T21:23:00.050Z",
  "updatedAt": "2025-12-16T21:23:00.050Z",
  "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-12-16T21:23:00.050Z",
          "updatedAt": "2025-12-16T21:23:00.050Z",
          "metadata": {
            "clouds": [
              "platform"
            ],
            "apps": [
              "inbox"
            ],
            "groups": [
              "text"
            ]
          }
        }
      ],
      "usersDependencyCount": 1,
      "accessKeysDependencyCount": 1,
      "createdAt": "2025-12-16T21:23:00.050Z",
      "updatedAt": "2025-12-16T21:23:00.050Z",
      "metadata": {
        "clouds": [
          "platform"
        ]
      },
      "actions": [
        {
          "name": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Delete access key

delete

Remove the access key from the organization.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

accessKeyIdstringRequired

ID for an access key

Responses

204

OK

No content

404

Resource not found

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Update access key

patch

Update the access key's properties.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

accessKeyIdstringRequired

ID for an access key

Body

application/json

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.

Responses

200

OK

application/json

404

Resource not found

application/json

409

Server had a temporary failure

application/json

422

Request validation failed

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "name": "text",
  "description": "text",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

{
  "id": "text",
  "organizationId": "text",
  "name": "text",
  "type": "user",
  "description": "text",
  "suffix": "text",
  "lastUsedAt": "2025-12-16T21:23:00.050Z",
  "createdAt": "2025-12-16T21:23:00.050Z",
  "updatedAt": "2025-12-16T21:23:00.050Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}