The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Settings
3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings
4---
5
16# Settings
27
38## Get effective organization settings
from line 28
2328
2429### Headers
2530
31- `"anthropic-version": optional string`
32
33 The version of the Claude API you want to use.
34
35 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
36
2637- `"x-api-key": optional string`
2738
2839### Returns
2940
41- `type: optional "effective_organization_settings"`
42
43 default: effective_organization_settings
44
3045- `api_keys: array of object`
3146
3247 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
3348
49 - `type: optional "compliance_api_key"`
50
51 default: compliance_api_key
52
3453 - `id: string`
3554
3655 Unique identifier for the API key.
from line 82
6382
6483 format: date-time
6584
66 - `type: optional "compliance_api_key"`
67
68 default: compliance_api_key
69
7085- `organization_id: string`
7186
7287- `settings: array of object or object or object or 3 more`
from line 90
7590
7691 A setting whose enforced value is a single true/false flag.
7792
78 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more`
93 - `type: optional "boolean"`
7994
95 default: boolean
96
97 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 53 more`
98
8099 - `"ai_powered_artifacts_enabled"`
81100
82101 - `"api_workbench_feedback_collection_enabled"`
from line 112
93112
94113 - `"claude_ai_integration_sharing_enabled"`
95114
115 - `"claude_ai_skill_plugins_scanning_enabled"`
116
96117 - `"claude_code_desktop_bypass_permissions_enabled"`
97118
98119 - `"claude_code_desktop_enabled"`
from line 210
189210
190211 - `value: boolean`
191212
192 - `type: optional "boolean"`
193
194 default: boolean
195
196213 - `Integer object`
197214
198215 A setting whose enforced value is a whole number; null means no limit
199216 is in force.
200217
201 - `name: "account_session_duration_seconds"`
202
203 - `value: number or null`
204
205218 - `type: optional "integer"`
206219
207220 default: integer
208221
222 - `name: "account_session_duration_seconds"`
223
224 - `value: number or null`
225
209226 - `String object`
210227
211228 A setting whose enforced value is a single string; null means no value
212229 is configured.
213230
231 - `type: optional "string"`
232
233 default: string
234
214235 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
215236
216237 - `"claude_code_default_worker_environment_id"`
from line 240
219240
220241 - `value: string or null`
221242
222 - `type: optional "string"`
223
224 default: string
225
226243 - `StringList object`
227244
228245 A setting whose enforced value is a list of strings.
229246
247 - `type: optional "string_list"`
248
249 default: string_list
250
230251 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
231252
232253 - `"allowed_invite_domains"`
from line 258
237258
238259 - `value: array of string`
239260
240 - `type: optional "string_list"`
241
242 default: string_list
243
244261 - `ProvisioningMode object`
245262
246263 How organization members are provisioned, resolved to the enforced mode.
from line 267
250267 modes require directory sync to be enabled. Otherwise `login_only` is
251268 reported, regardless of any stored configuration.
252269
270 - `type: optional "provisioning_mode"`
271
272 default: provisioning_mode
273
253274 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
254275
255276 How organization members are provisioned under SSO.
from line 289
268289
269290 default: sso_provisioning_mode
270291
271 - `type: optional "provisioning_mode"`
272
273 default: provisioning_mode
274
275292 - `DataRetention object`
276293
277294 The data retention periods in force, keyed by the type of data they
from line 299
282299 administrator-configured retention period is in force for that data type;
283300 Anthropic's service defaults may still apply.
284301
302 - `type: optional "data_retention"`
303
304 default: data_retention
305
285306 - `value: map[object or object]`
286307
287308 - `Fixed object`
from line 309
288309
289310 A fixed retention window measured from each item's last activity.
290311
312 - `type: optional "fixed"`
313
314 default: fixed
315
291316 - `duration: number`
292317
293318 - `timescale: "day" or "month"`
from line 321
296321
297322 - `"month"`
298323
299 - `type: optional "fixed"`
300
301 default: fixed
302
303324 - `Indefinite object`
304325
305326 An indefinite retention period: data is kept with no time limit.
from line 333
312333
313334 default: data_retention_periods
314335
315 - `type: optional "data_retention"`
316
317 default: data_retention
318
319- `type: optional "effective_organization_settings"`
320
321 default: effective_organization_settings
322
323336### Example
324337
325338```bash
from line 383
370383 cannot change — for example, one controlled by Anthropic policy or not
371384 available to the organization — is omitted from the list.
372385
386 - `type: optional "effective_organization_settings"`
387
388 default: effective_organization_settings
389
373390 - `api_keys: array of object`
374391
375392 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
376393
394 - `type: optional "compliance_api_key"`
395
396 default: compliance_api_key
397
377398 - `id: string`
378399
379400 Unique identifier for the API key.
from line 427
406427
407428 format: date-time
408429
409 - `type: optional "compliance_api_key"`
410
411 default: compliance_api_key
412
413430 - `organization_id: string`
414431
415432 - `settings: array of object or object or object or 3 more`
from line 435
418435
419436 A setting whose enforced value is a single true/false flag.
420437
421 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more`
438 - `type: optional "boolean"`
422439
440 default: boolean
441
442 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 53 more`
443
423444 - `"ai_powered_artifacts_enabled"`
424445
425446 - `"api_workbench_feedback_collection_enabled"`
from line 457
436457
437458 - `"claude_ai_integration_sharing_enabled"`
438459
460 - `"claude_ai_skill_plugins_scanning_enabled"`
461
439462 - `"claude_code_desktop_bypass_permissions_enabled"`
440463
441464 - `"claude_code_desktop_enabled"`
from line 555
532555
533556 - `value: boolean`
534557
535 - `type: optional "boolean"`
536
537 default: boolean
538
539558 - `Integer object`
540559
541560 A setting whose enforced value is a whole number; null means no limit
542561 is in force.
543562
544 - `name: "account_session_duration_seconds"`
545
546 - `value: number or null`
547
548563 - `type: optional "integer"`
549564
550565 default: integer
551566
567 - `name: "account_session_duration_seconds"`
568
569 - `value: number or null`
570
552571 - `String object`
553572
554573 A setting whose enforced value is a single string; null means no value
555574 is configured.
556575
576 - `type: optional "string"`
577
578 default: string
579
557580 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
558581
559582 - `"claude_code_default_worker_environment_id"`
from line 585
562585
563586 - `value: string or null`
564587
565 - `type: optional "string"`
566
567 default: string
568
569588 - `StringList object`
570589
571590 A setting whose enforced value is a list of strings.
572591
592 - `type: optional "string_list"`
593
594 default: string_list
595
573596 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
574597
575598 - `"allowed_invite_domains"`
from line 603
580603
581604 - `value: array of string`
582605
583 - `type: optional "string_list"`
584
585 default: string_list
586
587606 - `ProvisioningMode object`
588607
589608 How organization members are provisioned, resolved to the enforced mode.
from line 612
593612 modes require directory sync to be enabled. Otherwise `login_only` is
594613 reported, regardless of any stored configuration.
595614
615 - `type: optional "provisioning_mode"`
616
617 default: provisioning_mode
618
596619 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
597620
598621 How organization members are provisioned under SSO.
from line 634
611634
612635 default: sso_provisioning_mode
613636
614 - `type: optional "provisioning_mode"`
615
616 default: provisioning_mode
617
618637 - `DataRetention object`
619638
620639 The data retention periods in force, keyed by the type of data they
from line 644
625644 administrator-configured retention period is in force for that data type;
626645 Anthropic's service defaults may still apply.
627646
647 - `type: optional "data_retention"`
648
649 default: data_retention
650
628651 - `value: map[object or object]`
629652
630653 - `Fixed object`
from line 654
631654
632655 A fixed retention window measured from each item's last activity.
633656
657 - `type: optional "fixed"`
658
659 default: fixed
660
634661 - `duration: number`
635662
636663 - `timescale: "day" or "month"`
from line 666
639666
640667 - `"month"`
641668
642 - `type: optional "fixed"`
643
644 default: fixed
645
646669 - `Indefinite object`
647670
648671 An indefinite retention period: data is kept with no time limit.
from line 677
654677 - `name: optional "data_retention_periods"`
655678
656679 default: data_retention_periods
657
658 - `type: optional "data_retention"`
659
660 default: data_retention
661
662 - `type: optional "effective_organization_settings"`
663
664 default: effective_organization_settings
665680