API Keys

Issue an API key

Changed on

Issues an exact-scope credential for an existing workspace member or a new named agent. Requires api_keys:write, a live admin/owner membership, and an Idempotency-Key. The encrypted secret response is replayable for 24 hours; after that it cannot be recovered. Credential-management scopes cannot be delegated.

post/api-keys

Request

  • Base URL
    https://api.ando.so/v1
  • URL
    https://api.ando.so/v1/api-keys
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

Idempotency-Keystring required

Idempotency key.

Required key for safe retries. Reusing it with different parameters returns 409 idempotency_conflict. The encrypted secret response can be replayed for 24 hours.

Request body

namestring nullable required

Optional operator-facing key label.

scopesstring[] required

Exact non-administrative scopes to grant.

Example request

{
  "subject": {
    "workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
  }
}

Response

Issued API key.

Example response

{
  "data": {
    "key": {
      "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
      "subject": {
        "workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
      }
    }
  }
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      added the new slack_migration:read enum value to the /// response property for the response status

    • warning

      added the new slack_migration:write enum value to the /// response property for the response status