Roles

List Compliance Roles

get /v1/compliance/organizations/{org_uuid}/roles

List Compliance Roles

Path Parameters

• org_uuid: string

  The organization UUID

Query Parameters

• limit: optional number

  Maximum results (default: 500, max: 1000)

• page: optional string

  Opaque pagination token from a previous response's next_page field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.

Header Parameters

• "x-api-key": optional string

Returns

• data: array of object { id, created_at, description, 2 more }

  List of roles

  • id: string

    Role identifier (tagged ID)

  • created_at: string

    Role creation timestamp (ISO 8601)

  • description: string

    Role description

  • name: string

    Role name

  • updated_at: string

    Role last-updated timestamp (ISO 8601)

• has_more: boolean

  Whether more records exist beyond the current result set

• next_page: string

  Token to retrieve the next page. Use this as the 'page' parameter in your next request

Example

curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "id": "id",
      "created_at": "created_at",
      "description": "description",
      "name": "name",
      "updated_at": "updated_at"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

Get Compliance Role

get /v1/compliance/organizations/{org_uuid}/roles/{role_id}

Get Compliance Role

Path Parameters

• org_uuid: string

  The organization UUID

• role_id: string

  The role ID (tagged ID, e.g., rbac_role_abc123)

Header Parameters

• "x-api-key": optional string

Returns

• id: string

  Role identifier (tagged ID)

• created_at: string

  Role creation timestamp (ISO 8601)

• description: string

  Role description

• name: string

  Role name

• updated_at: string

  Role last-updated timestamp (ISO 8601)

Example

curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "created_at": "created_at",
  "description": "description",
  "name": "name",
  "updated_at": "updated_at"
}

Domain Types

Role List Response

• RoleListResponse object { id, created_at, description, 2 more }

  Role information for compliance responses.

  • id: string

    Role identifier (tagged ID)

  • created_at: string

    Role creation timestamp (ISO 8601)

  • description: string

    Role description

  • name: string

    Role name

  • updated_at: string

    Role last-updated timestamp (ISO 8601)

Role Retrieve Response

• RoleRetrieveResponse object { id, created_at, description, 2 more }

  Role information for compliance responses.

  • id: string

    Role identifier (tagged ID)

  • created_at: string

    Role creation timestamp (ISO 8601)

  • description: string

    Role description

  • name: string

    Role name

  • updated_at: string

    Role last-updated timestamp (ISO 8601)

Permissions

List Compliance Role Permissions

get /v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions

List Compliance Role Permissions

Path Parameters

• org_uuid: string

  The organization UUID

• role_id: string

  The role ID (tagged ID, e.g., rbac_role_abc123)

Query Parameters

• limit: optional number

  Maximum results (default: 500, max: 1000)

• page: optional string

  Opaque pagination token from a previous response's next_page field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.

Header Parameters

• "x-api-key": optional string

Returns

• data: array of object { action, resource_id, resource_type }

  List of permissions

  • action: string

    Action permitted on the resource

  • resource_id: string

    Identifier of the resource the permission applies to

  • resource_type: string

    Type of resource the permission applies to

• has_more: boolean

  Whether more records exist beyond the current result set

• next_page: string

  Token to retrieve the next page. Use this as the 'page' parameter in your next request

Example

curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "action": "action",
      "resource_id": "resource_id",
      "resource_type": "resource_type"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

Domain Types

Permission List Response

• PermissionListResponse object { action, resource_id, resource_type }

  Permission granted by a role.

  • action: string

    Action permitted on the resource

  • resource_id: string

    Identifier of the resource the permission applies to

  • resource_type: string

    Type of resource the permission applies to