The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Organizations
3url: https://platform.claude.com/docs/en/api/compliance/organizations
4---
5
61# Organizations
72
83## List organizations
94
10**get** `/v1/compliance/organizations`
5**GET** `/v1/compliance/organizations`
116
127List organizations under the parent organization.
138
from line 10
1510`limit` and `page` to paginate: each response includes `has_more` and a
1611`next_page` token to pass on the next request.
1712
18### Query Parameters
13### Query parameters
1914
2015- `limit: optional number`
2116
2217 Maximum results (default: 1000, max: 1000)
2318
19 default: 1000, maximum: 1000, minimum: 1
20
2421- `page: optional string`
2522
2623 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.
2724
28### Header Parameters
25### Headers
2926
3027- `"x-api-key": optional string`
3128
3229### Returns
3330
34- `data: array of object { created_at, name, uuid }`
31- `data: array of object`
3532
3633 List of organizations sorted by creation date, ascending
3734
from line 54
5754
5855### Example
5956
60```http
57```bash
6158curl https://api.anthropic.com/v1/compliance/organizations \
6259 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
6360```
6461
65#### Response
62#### Response (200)
6663
6764```json
6865{
from line 75
7875}
7976```
8077
81## Domain Types
78## Domain types
8279
8380### Organization List Response
8481
85- `OrganizationListResponse object { created_at, name, uuid }`
82- `OrganizationListResponse object`
8683
8784 Information about an organization.
8885
from line 95
9895
9996 Unique identifier for the organization (UUID format)
10097
101# Users
102
103## List organization users
104
105**get** `/v1/compliance/organizations/{org_uuid}/users`
98## Organizations › Users
99
100### List organization users
101
102**GET** `/v1/compliance/organizations/{org_uuid}/users`
106103
107104List current user members of an organization.
108105
109### Path Parameters
106#### Path parameters
110107
111108- `org_uuid: string`
112109
113110 The organization UUID
114111
115### Query Parameters
112#### Query parameters
116113
117114- `limit: optional number`
118115
119116 Maximum results (default: 500, max: 1000)
120117
118 default: 500, maximum: 1000, minimum: 1
119
121120- `page: optional string`
122121
123122 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.
124123
125### Header Parameters
124#### Headers
126125
127126- `"x-api-key": optional string`
128127
129### Returns
130
131- `data: array of object { id, created_at, email, 2 more }`
128#### Returns
129
130- `data: array of object`
132131
133132 List of current organization members sorted by organization join date ascending
134133
from line 139
140139
141140 User account creation timestamp
142141
142 format: date-time
143
143144 - `email: string`
144145
145146 User's current email address
from line 179
178179
179180 Token to retrieve the next page. Use this as the 'page' parameter in your next request
180181
181### Example
182
183```http
182#### Example
183
184```bash
184185curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/users \
185186 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
186187```
187188
188#### Response
189##### Response (200)
189190
190191```json
191192{
from line 204
203204}
204205```
205206
206## Domain Types
207
208### User List Response
209
210- `UserListResponse object { id, created_at, email, 2 more }`
211
212 User member information for compliance responses.
207## Organizations › Roles
208
209### List Compliance Roles
210
211**GET** `/v1/compliance/organizations/{org_uuid}/roles`
212
213List Compliance Roles
214
215#### Path parameters
216
217- `org_uuid: string`
218
219 The organization UUID
220
221#### Query parameters
222
223- `limit: optional number`
224
225 Maximum results (default: 500, max: 1000)
226
227 default: 500, maximum: 1000, minimum: 1
228
229- `page: optional string`
230
231 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.
232
233#### Headers
234
235- `"x-api-key": optional string`
236
237#### Returns
238
239- `data: array of object`
240
241 List of roles
213242
214243 - `id: string`
215244
216 User identifier (tagged ID)
217
218 - `created_at: string`
219
220 User account creation timestamp
221
222 - `email: string`
223
224 User's current email address
225
226 - `full_name: string`
227
228 User's current full name
229
230 - `organization_role: "admin" or "billing" or "claude_code_user" or 6 more`
231
232 User's built-in role within the organization. This is distinct from any custom RBAC roles that may also be assigned.
233
234 - `"admin"`
235
236 - `"billing"`
237
238 - `"claude_code_user"`
239
240 - `"developer"`
241
242 - `"managed"`
243
244 - `"membership_admin"`
245
246 - `"owner"`
247
248 - `"primary_owner"`
249
250 - `"user"`
251
252# Roles
253
254## List Compliance Roles
255
256**get** `/v1/compliance/organizations/{org_uuid}/roles`
257
258List Compliance Roles
259
260### Path Parameters
261
262- `org_uuid: string`
263
264 The organization UUID
265
266### Query Parameters
267
268- `limit: optional number`
269
270 Maximum results (default: 500, max: 1000)
271
272- `page: optional string`
273
274 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.
275
276### Header Parameters
277
278- `"x-api-key": optional string`
279
280### Returns
281
282- `data: array of object { id, created_at, description, 2 more }`
283
284 List of roles
285
286 - `id: string`
287
288245 Role identifier (tagged ID)
289246
290247 - `created_at: string or null`
from line 268
311268
312269 Token to retrieve the next page. Use this as the 'page' parameter in your next request
313270
314### Example
315
316```http
271#### Example
272
273```bash
317274curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \
318275 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
319276```
320277
321#### Response
278##### Response (200)
322279
323280```json
324281{
from line 293
336293}
337294```
338295
339## Get Compliance Role
340
341**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
296### Get Compliance Role
297
298**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
342299
343300Get Compliance Role
344301
345### Path Parameters
302#### Path parameters
346303
347304- `org_uuid: string`
348305
from line 309
352309
353310 The role ID (tagged ID, e.g., rbac_role_abc123)
354311
355### Header Parameters
312#### Headers
356313
357314- `"x-api-key": optional string`
358315
359### Returns
316#### Returns
360317
361318- `id: string`
362319
from line 335
378335
379336 Role last-updated timestamp (ISO 8601)
380337
381### Example
382
383```http
338#### Example
339
340```bash
384341curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \
385342 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
386343```
387344
388#### Response
345##### Response (200)
389346
390347```json
391348{
from line 354
397354}
398355```
399356
400## Domain Types
401
402### Role List Response
403
404- `RoleListResponse object { id, created_at, description, 2 more }`
405
406 Role information for compliance responses.
407
408 - `id: string`
409
410 Role identifier (tagged ID)
411
412 - `created_at: string or null`
413
414 Role creation timestamp (ISO 8601)
415
416 - `description: string`
417
418 Role description
419
420 - `name: string`
421
422 Role name
423
424 - `updated_at: string or null`
425
426 Role last-updated timestamp (ISO 8601)
427
428### Role Retrieve Response
429
430- `RoleRetrieveResponse object { id, created_at, description, 2 more }`
431
432 Role information for compliance responses.
433
434 - `id: string`
435
436 Role identifier (tagged ID)
437
438 - `created_at: string or null`
439
440 Role creation timestamp (ISO 8601)
441
442 - `description: string`
443
444 Role description
445
446 - `name: string`
447
448 Role name
449
450 - `updated_at: string or null`
451
452 Role last-updated timestamp (ISO 8601)
453
454# Permissions
455
456## List Compliance Role Permissions
457
458**get** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
357## Organizations › Roles › Permissions
358
359### List Compliance Role Permissions
360
361**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
459362
460363List Compliance Role Permissions
461364
462### Path Parameters
365#### Path parameters
463366
464367- `org_uuid: string`
465368
from line 372
469372
470373 The role ID (tagged ID, e.g., rbac_role_abc123)
471374
472### Query Parameters
375#### Query parameters
473376
474377- `limit: optional number`
475378
476379 Maximum results (default: 500, max: 1000)
477380
381 default: 500, maximum: 1000, minimum: 1
382
478383- `page: optional string`
479384
480385 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.
481386
482### Header Parameters
387#### Headers
483388
484389- `"x-api-key": optional string`
485390
486### Returns
487
488- `data: array of object { action, resource_id, resource_type }`
391#### Returns
392
393- `data: array of object`
489394
490395 List of permissions
491396
from line 414
509414
510415 Token to retrieve the next page. Use this as the 'page' parameter in your next request
511416
512### Example
513
514```http
417#### Example
418
419```bash
515420curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
516421 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
517422```
518423
519#### Response
424##### Response (200)
520425
521426```json
522427{
from line 437
532437}
533438```
534439
535## Domain Types
536
537### Permission List Response
538
539- `PermissionListResponse object { action, resource_id, resource_type }`
540
541 Permission granted by a role.
542
543 - `action: string`
544
545 Action permitted on the resource
546
547 - `resource_id: string`
548
549 Identifier of the resource the permission applies to
550
551 - `resource_type: string`
552
553 Type of resource the permission applies to
554
555# Settings
556
557## Get effective organization settings
558
559**get** `/v1/compliance/organizations/{organization_id}/settings`
440## Organizations › Settings
441
442### Get effective organization settings
443
444**GET** `/v1/compliance/organizations/{organization_id}/settings`
560445
561446Retrieve the effective settings for an organization.
562447
from line 454
569454The organization must belong to the API key's organization hierarchy;
570455unknown organizations and organizations outside the hierarchy return 404.
571456
572### Path Parameters
457#### Path parameters
573458
574459- `organization_id: string`
575460
576461 The organization's UUID
577462
578### Header Parameters
463#### Headers
579464
580465- `"x-api-key": optional string`
581466
582### Returns
583
584- `api_keys: array of object { id, created_at, created_by_id, 5 more }`
467#### Returns
468
469- `api_keys: array of object`
585470
586471 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
587472
from line 478
593478
594479 When the key was created.
595480
481 format: date-time
482
596483 - `created_by_id: string or null`
597484
598485 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
from line 500
613500
614501 When the key will stop authenticating, or null when the key does not expire.
615502
503 format: date-time
504
616505 - `type: optional "compliance_api_key"`
617506
618 - `"compliance_api_key"`
507 default: compliance_api_key
619508
620509- `organization_id: string`
621510
622- `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
623
624 - `Boolean object { name, value, type }`
511- `settings: array of object or object or object or 3 more`
512
513 - `Boolean object`
625514
626515 A setting whose enforced value is a single true/false flag.
627516
from line 614
725614
726615 - `type: optional "boolean"`
727616
728 - `"boolean"`
729
730 - `Integer object { name, value, type }`
617 default: boolean
618
619 - `Integer object`
731620
732621 A setting whose enforced value is a whole number; null means no limit
733622 is in force.
734623
735624 - `name: "account_session_duration_seconds"`
736625
737 - `"account_session_duration_seconds"`
738
739626 - `value: number or null`
740627
741628 - `type: optional "integer"`
742629
743 - `"integer"`
744
745 - `String object { name, value, type }`
630 default: integer
631
632 - `String object`
746633
747634 A setting whose enforced value is a single string; null means no value
748635 is configured.
from line 644
757644
758645 - `type: optional "string"`
759646
760 - `"string"`
761
762 - `StringList object { name, value, type }`
647 default: string
648
649 - `StringList object`
763650
764651 A setting whose enforced value is a list of strings.
765652
from line 662
775662
776663 - `type: optional "string_list"`
777664
778 - `"string_list"`
779
780 - `ProvisioningMode object { value, name, type }`
665 default: string_list
666
667 - `ProvisioningMode object`
781668
782669 How organization members are provisioned, resolved to the enforced mode.
783670
from line 689
802689
803690 - `name: optional "sso_provisioning_mode"`
804691
805 - `"sso_provisioning_mode"`
692 default: sso_provisioning_mode
806693
807694 - `type: optional "provisioning_mode"`
808695
809 - `"provisioning_mode"`
810
811 - `DataRetention object { value, name, type }`
696 default: provisioning_mode
697
698 - `DataRetention object`
812699
813700 The data retention periods in force, keyed by the type of data they
814701 apply to.
from line 705
818705 administrator-configured retention period is in force for that data type;
819706 Anthropic's service defaults may still apply.
820707
821 - `value: map[object { duration, timescale, type } or object { type } ]`
822
823 - `Fixed object { duration, timescale, type }`
708 - `value: map[object or object]`
709
710 - `Fixed object`
824711
825712 A fixed retention window measured from each item's last activity.
826713
from line 721
834721
835722 - `type: optional "fixed"`
836723
837 - `"fixed"`
838
839 - `Indefinite object { type }`
724 default: fixed
725
726 - `Indefinite object`
840727
841728 An indefinite retention period: data is kept with no time limit.
842729
843730 - `type: optional "indefinite"`
844731
845 - `"indefinite"`
732 default: indefinite
846733
847734 - `name: optional "data_retention_periods"`
848735
849 - `"data_retention_periods"`
736 default: data_retention_periods
850737
851738 - `type: optional "data_retention"`
852739
853 - `"data_retention"`
740 default: data_retention
854741
855742- `type: optional "effective_organization_settings"`
856743
857 - `"effective_organization_settings"`
858
859### Example
860
861```http
744 default: effective_organization_settings
745
746#### Example
747
748```bash
862749curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \
863750 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
864751```
865752
866#### Response
753##### Response (200)
867754
868755```json
869756{
from line 779
892779 "type": "effective_organization_settings"
893780}
894781```
895
896## Domain Types
897
898### Setting Retrieve Response
899
900- `SettingRetrieveResponse object { api_keys, organization_id, settings, type }`
901
902 The resolved settings in force for one organization at read time.
903
904 Settings appear at most once each, in a fixed relative order, and values
905 reflect the enforced state. A setting the organization's administrators
906 cannot change — for example, one controlled by Anthropic policy or not
907 available to the organization — is omitted from the list.
908
909 - `api_keys: array of object { id, created_at, created_by_id, 5 more }`
910
911 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
912
913 - `id: string`
914
915 Unique identifier for the API key.
916
917 - `created_at: string`
918
919 When the key was created.
920
921 - `created_by_id: string or null`
922
923 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
924
925 - `is_active: boolean`
926
927 Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.
928
929 - `name: string`
930
931 The name given to the API key when it was created.
932
933 - `scopes: array of string`
934
935 The permission scopes granted to the key.
936
937 - `expires_at: optional string or null`
938
939 When the key will stop authenticating, or null when the key does not expire.
940
941 - `type: optional "compliance_api_key"`
942
943 - `"compliance_api_key"`
944
945 - `organization_id: string`
946
947 - `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more`
948
949 - `Boolean object { name, value, type }`
950
951 A setting whose enforced value is a single true/false flag.
952
953 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more`
954
955 - `"ai_powered_artifacts_enabled"`
956
957 - `"api_workbench_feedback_collection_enabled"`
958
959 - `"artifact_connectors_enabled"`
960
961 - `"ask_your_org_enabled"`
962
963 - `"chat_enabled"`
964
965 - `"claude_ai_chat_sharing_enabled"`
966
967 - `"claude_ai_feedback_collection_enabled"`
968
969 - `"claude_ai_integration_sharing_enabled"`
970
971 - `"claude_code_desktop_bypass_permissions_enabled"`
972
973 - `"claude_code_desktop_enabled"`
974
975 - `"claude_code_fast_mode_enabled"`
976
977 - `"claude_code_metrics_logging_enabled"`
978
979 - `"claude_code_remote_control_enabled"`
980
981 - `"claude_code_review_enabled"`
982
983 - `"claude_code_routines_enabled"`
984
985 - `"claude_code_security_enabled"`
986
987 - `"claude_code_trusted_devices_required"`
988
989 - `"claude_code_web_enabled"`
990
991 - `"claude_code_workflows_enabled"`
992
993 - `"claude_design_enabled"`
994
995 - `"claude_in_slack_enabled"`
996
997 - `"code_execution_enabled"`
998
999 - `"code_execution_network_egress_enabled"`
1000
1001 - `"connector_tools_default_always_allow"`
1002
1003 - `"content_redaction_enabled"`
1004
1005 - `"cowork_trusted_devices_required"`
1006
1007 - `"desktop_extension_allowlist_enabled"`
1008
1009 - `"directory_sync_enabled"`
1010
1011 - `"frontier_data_use_enabled"`
1012
1013 - `"group_skill_sharing_enabled"`
1014
1015 - `"hipaa_compliance_enabled"`
1016
1017 - `"inline_visualizations_enabled"`
1018
1019 - `"ip_allowlist_enabled"`
1020
1021 - `"location_metadata_enabled"`
1022
1023 - `"member_usage_dashboard_visible"`
1024
1025 - `"memory_enabled"`
1026
1027 - `"org_wide_skill_sharing_enabled"`
1028
1029 - `"public_projects_enabled"`
1030
1031 - `"skill_sharing_enabled"`
1032
1033 - `"skills_enabled"`
1034
1035 - `"sso_claude_ai_enforced"`
1036
1037 - `"sso_console_enforced"`
1038
1039 - `"sso_enabled"`
1040
1041 - `"third_party_interactive_content_enabled"`
1042
1043 - `"user_skill_creation_enabled"`
1044
1045 - `"web_search_enabled"`
1046
1047 - `"work_across_apps_enabled"`
1048
1049 - `value: boolean`
1050
1051 - `type: optional "boolean"`
1052
1053 - `"boolean"`
1054
1055 - `Integer object { name, value, type }`
1056
1057 A setting whose enforced value is a whole number; null means no limit
1058 is in force.
1059
1060 - `name: "account_session_duration_seconds"`
1061
1062 - `"account_session_duration_seconds"`
1063
1064 - `value: number or null`
1065
1066 - `type: optional "integer"`
1067
1068 - `"integer"`
1069
1070 - `String object { name, value, type }`
1071
1072 A setting whose enforced value is a single string; null means no value
1073 is configured.
1074
1075 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
1076
1077 - `"claude_code_default_worker_environment_id"`
1078
1079 - `"claude_code_default_worker_pool_id"`
1080
1081 - `value: string or null`
1082
1083 - `type: optional "string"`
1084
1085 - `"string"`
1086
1087 - `StringList object { name, value, type }`
1088
1089 A setting whose enforced value is a list of strings.
1090
1091 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
1092
1093 - `"allowed_invite_domains"`
1094
1095 - `"disabled_admin_request_types"`
1096
1097 - `"ip_allowlist_ip_ranges"`
1098
1099 - `value: array of string`
1100
1101 - `type: optional "string_list"`
1102
1103 - `"string_list"`
1104
1105 - `ProvisioningMode object { value, name, type }`
1106
1107 How organization members are provisioned, resolved to the enforced mode.
1108
1109 A configured mode is reported only while the mechanism that enforces it is
1110 active: just-in-time modes require single sign-on to be enabled, and SCIM
1111 modes require directory sync to be enabled. Otherwise `login_only` is
1112 reported, regardless of any stored configuration.
1113
1114 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
1115
1116 How organization members are provisioned under SSO.
1117
1118 - `"jit_advanced"`
1119
1120 - `"jit_permissive"`
1121
1122 - `"login_only"`
1123
1124 - `"scim_advanced"`
1125
1126 - `"scim_permissive"`
1127
1128 - `name: optional "sso_provisioning_mode"`
1129
1130 - `"sso_provisioning_mode"`
1131
1132 - `type: optional "provisioning_mode"`
1133
1134 - `"provisioning_mode"`
1135
1136 - `DataRetention object { value, name, type }`
1137
1138 The data retention periods in force, keyed by the type of data they
1139 apply to.
1140
1141 A key of `all` covers every data type and is exclusive: when present it
1142 is the only key. A missing key means no organization-level
1143 administrator-configured retention period is in force for that data type;
1144 Anthropic's service defaults may still apply.
1145
1146 - `value: map[object { duration, timescale, type } or object { type } ]`
1147
1148 - `Fixed object { duration, timescale, type }`
1149
1150 A fixed retention window measured from each item's last activity.
1151
1152 - `duration: number`
1153
1154 - `timescale: "day" or "month"`
1155
1156 - `"day"`
1157
1158 - `"month"`
1159
1160 - `type: optional "fixed"`
1161
1162 - `"fixed"`
1163
1164 - `Indefinite object { type }`
1165
1166 An indefinite retention period: data is kept with no time limit.
1167
1168 - `type: optional "indefinite"`
1169
1170 - `"indefinite"`
1171
1172 - `name: optional "data_retention_periods"`
1173
1174 - `"data_retention_periods"`
1175
1176 - `type: optional "data_retention"`
1177
1178 - `"data_retention"`
1179
1180 - `type: optional "effective_organization_settings"`
1181
1182 - `"effective_organization_settings"`
1183782
No line in this hunk matches that.