Skip to main content
Every IAM endpoint lives under /v2/iam/, takes the organization owner’s credential, and answers in the standard data and meta envelope.

Conventions

  • Lists take page[size], up to 250 and 25 by default, and page[number]. meta carries total_results, total_pages, page_number, and page_size.
  • Roles, grants, settings, and service accounts are scoped to the owner’s organization. An ID of another organization answers 404.
  • Only the organization owner manages IAM. Every /v2/iam route, the catalog and the service account routes included, answers 403 to anyone else, service account tokens included.
  • The action catalog is the same for every organization.
  • Role, statement, grant, user, and service account IDs are UUIDs. A user’s ID is the one the Organization Users API returns.

Endpoints

Every endpoint in this section is available. The endpoints under Preview are not available yet.

Service Account Tokens

Every token route below starts with /v2/iam/service_accounts/{id}.

Decisions

Preview

These endpoints are not available yet. The pages that describe them show the intended behavior.
Roles, their statements, and grants are described with their bodies on Roles and Grants, the settings on Enable IAM, and the action catalog, GET /v2/iam/actions, on Actions.