Roles
api/compliance/organizations/roles
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/compliance/organizations/roles Changed · +34 / -55 lines
### Path parameters ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## Roles › Permissions ### List Compliance Role Permissions #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Path Parameters ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Permissions ## List Compliance Role Permissions ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### Permission List Response
---- -title: Roles -url: https://platform.claude.com/docs/en/api/compliance/organizations/roles ---- - # Roles ## List Compliance Roles -**get** `/v1/compliance/organizations/{org_uuid}/roles` +**GET** `/v1/compliance/organizations/{org_uuid}/roles` List Compliance Roles -### Path Parameters +### Path parameters - `org_uuid: string` The organization UUID -### Query Parameters +### Query parameters - `limit: optional number` Maximum results (default: 500, max: 1000) + default: 500, maximum: 1000, minimum: 1 + - `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 +### Headers - `"x-api-key": optional string` ### Returns -- `data: array of object { id, created_at, description, 2 more }` +- `data: array of object` List of roles
### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -#### Response +#### Response (200) ```json {
## Get Compliance Role -**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}` +**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}` Get Compliance Role -### Path Parameters +### Path parameters - `org_uuid: string`
The role ID (tagged ID, e.g., rbac_role_abc123) -### Header Parameters +### Headers - `"x-api-key": optional string`
### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -#### Response +#### Response (200) ```json {
} ``` -## Domain Types +## Domain types ### Role List Response -- `RoleListResponse object { id, created_at, description, 2 more }` +- `RoleListResponse object` Role information for compliance responses.
### Role Retrieve Response -- `RoleRetrieveResponse object { id, created_at, description, 2 more }` +- `RoleRetrieveResponse object` Role information for compliance responses.
Role last-updated timestamp (ISO 8601) -# Permissions +## Roles › Permissions -## List Compliance Role Permissions +### List Compliance Role Permissions -**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions` +**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions` List Compliance Role Permissions -### Path Parameters +#### Path parameters - `org_uuid: string`
The role ID (tagged ID, e.g., rbac_role_abc123) -### Query Parameters +#### Query parameters - `limit: optional number` Maximum results (default: 500, max: 1000) + default: 500, maximum: 1000, minimum: 1 + - `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 +#### Headers - `"x-api-key": optional string` -### Returns +#### Returns -- `data: array of object { action, resource_id, resource_type }` +- `data: array of object` List of permissions
Token to retrieve the next page. Use this as the 'page' parameter in your next request -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -#### Response +##### Response (200) ```json {
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=" } ``` - -## 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