Skip to content
Open Console →

IAM

2 endpoints under /api/v1/iam.

GET /api/v1/iam/catalog #

The grantable roles and scopable resources

Responses

200 Built-in grantable Roles plus the org's live scopable resource instances.
Response body
  • rolesIamRole[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • descriptionstringrequired
    • kindstring · enumrequired

      builtincustom

    • servicestring
    • scopablebooleanrequired
    • permissionsstring[]required
  • resourcesIamResource[]required
    Show fields
    • servicestringrequired
    • idstringrequired
    • namestringrequired
400 Unknown role/subject, or an invalid resource selector.
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires grant management (owner/admin in v1).
Response body
  • errorstringrequired
GET /api/v1/iam/permissions #

The permission catalog for authoring custom roles

Responses

200 Every service, its resources, and the read/write/admin permission atoms — grouped and labeled.
Response body
  • servicesPermissionCatalogService[]required
    Show fields
    • servicestringrequired
    • serviceLabelstringrequired
    • resourcesobject[]required
      Show fields
      • resourcestringrequired
      • resourceLabelstringrequired
      • tiersPermissionCatalogTier[]required
        Show fields
        • permissionstringrequired
        • tierstring · enumrequired

          readwriteadmin

        • labelstringrequired