中文 ← MyDocs

Organizations

List organizations

get /v1/compliance/organizations

List organizations under the parent organization.

Returns a list of organizations sorted by creation date in ascending order. This endpoint does not support pagination and will return an error if the response would exceed 1,000 organizations.

Header Parameters

  • "x-api-key": optional string

Returns

  • data: array of object { created_at, name, uuid }

    List of organizations sorted by creation date, ascending

    • created_at: string

      Organization creation time (RFC 3339 format)

    • name: string

      Organization name

    • uuid: string

      Unique identifier for the organization (UUID format)

Example

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

Response

{
  "data": [
    {
      "created_at": "created_at",
      "name": "name",
      "uuid": "uuid"
    }
  ]
}

Domain Types

Organization List Response

  • OrganizationListResponse object { data }

    List of organizations under a parent organization.

    • data: array of object { created_at, name, uuid }

      List of organizations sorted by creation date, ascending

      • created_at: string

        Organization creation time (RFC 3339 format)

      • name: string

        Organization name

      • uuid: string

        Unique identifier for the organization (UUID format)

Users

List organization users

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

List current user members of an organization.

Returns: List of user members with pagination info

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, email, 2 more }

    List of current organization members sorted by organization join date ascending

    • id: string

      User identifier (tagged ID)

    • created_at: string

      User account creation timestamp

    • email: string

      User's current email address

    • full_name: string

      User's current full name

    • organization_role: "admin" or "billing" or "claude_code_user" or 6 more

      User's built-in role within the organization. This is distinct from any custom RBAC roles that may also be assigned.

      • "admin"

      • "billing"

      • "claude_code_user"

      • "developer"

      • "managed"

      • "membership_admin"

      • "owner"

      • "primary_owner"

      • "user"

  • 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/users \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "email",
      "full_name": "full_name",
      "organization_role": "admin"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

Domain Types

User List Response

  • UserListResponse object { id, created_at, email, 2 more }

    User member information for compliance responses.

    • id: string

      User identifier (tagged ID)

    • created_at: string

      User account creation timestamp

    • email: string

      User's current email address

    • full_name: string

      User's current full name

    • organization_role: "admin" or "billing" or "claude_code_user" or 6 more

      User's built-in role within the organization. This is distinct from any custom RBAC roles that may also be assigned.

      • "admin"

      • "billing"

      • "claude_code_user"

      • "developer"

      • "managed"

      • "membership_admin"

      • "owner"

      • "primary_owner"

      • "user"

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