One change
Settings
api/compliance/organizations/settings
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/settings Changed · +77 / -78 lines
### Path parameters ### Headers #### Response (200) ## Domain types ### Path Parameters ### Header Parameters #### Response ## Domain Types
from line 1
---- -title: Settings -url: https://platform.claude.com/docs/en/api/compliance/organizations/settings ---- - # Settings ## Get effective organization settings -**get** `/v1/compliance/organizations/{organization_id}/settings` +**GET** `/v1/compliance/organizations/{organization_id}/settings` Retrieve the effective settings for an organization.
from line 15
The organization must belong to the API key's organization hierarchy; unknown organizations and organizations outside the hierarchy return 404. -### Path Parameters +### Path parameters - `organization_id: string` The organization's UUID -### Header Parameters +### Headers - `"x-api-key": optional string` ### Returns -- `api_keys: array of object { id, created_at, created_by_id, 5 more }` +- `api_keys: array of object` Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
from line 39
When the key was created. + format: date-time + - `created_by_id: string or null` 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 61
When the key will stop authenticating, or null when the key does not expire. + format: date-time + - `type: optional "compliance_api_key"` - - `"compliance_api_key"` + default: compliance_api_key - `organization_id: string` -- `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more` +- `settings: array of object or object or object or 3 more` - - `Boolean object { name, value, type }` + - `Boolean object` A setting whose enforced value is a single true/false flag.
from line 175
- `type: optional "boolean"` - - `"boolean"` + default: boolean - - `Integer object { name, value, type }` + - `Integer object` A setting whose enforced value is a whole number; null means no limit is in force.
from line 184
- `name: "account_session_duration_seconds"` - - `"account_session_duration_seconds"` - - `value: number or null` - `type: optional "integer"` - - `"integer"` + default: integer - - `String object { name, value, type }` + - `String object` A setting whose enforced value is a single string; null means no value is configured.
from line 205
- `type: optional "string"` - - `"string"` + default: string - - `StringList object { name, value, type }` + - `StringList object` A setting whose enforced value is a list of strings.
from line 223
- `type: optional "string_list"` - - `"string_list"` + default: string_list - - `ProvisioningMode object { value, name, type }` + - `ProvisioningMode object` How organization members are provisioned, resolved to the enforced mode.
from line 250
- `name: optional "sso_provisioning_mode"` - - `"sso_provisioning_mode"` + default: sso_provisioning_mode - `type: optional "provisioning_mode"` - - `"provisioning_mode"` + default: provisioning_mode - - `DataRetention object { value, name, type }` + - `DataRetention object` The data retention periods in force, keyed by the type of data they apply to.
from line 266
administrator-configured retention period is in force for that data type; Anthropic's service defaults may still apply. - - `value: map[object { duration, timescale, type } or object { type } ]` + - `value: map[object or object]` - - `Fixed object { duration, timescale, type }` + - `Fixed object` A fixed retention window measured from each item's last activity.
from line 282
- `type: optional "fixed"` - - `"fixed"` + default: fixed - - `Indefinite object { type }` + - `Indefinite object` An indefinite retention period: data is kept with no time limit. - `type: optional "indefinite"` - - `"indefinite"` + default: indefinite - `name: optional "data_retention_periods"` - - `"data_retention_periods"` + default: data_retention_periods - `type: optional "data_retention"` - - `"data_retention"` + default: data_retention - `type: optional "effective_organization_settings"` - - `"effective_organization_settings"` + default: effective_organization_settings ### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 341
} ``` -## Domain Types +## Domain types ### Setting Retrieve Response -- `SettingRetrieveResponse object { api_keys, organization_id, settings, type }` +- `SettingRetrieveResponse object` The resolved settings in force for one organization at read time.
from line 354
cannot change — for example, one controlled by Anthropic policy or not available to the organization — is omitted from the list. - - `api_keys: array of object { id, created_at, created_by_id, 5 more }` + - `api_keys: array of object` Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
from line 366
When the key was created. + format: date-time + - `created_by_id: string or null` 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 388
When the key will stop authenticating, or null when the key does not expire. + format: date-time + - `type: optional "compliance_api_key"` - - `"compliance_api_key"` + default: compliance_api_key - `organization_id: string` - - `settings: array of object { name, value, type } or object { name, value, type } or object { name, value, type } or 3 more` + - `settings: array of object or object or object or 3 more` - - `Boolean object { name, value, type }` + - `Boolean object` A setting whose enforced value is a single true/false flag.
from line 502
- `type: optional "boolean"` - - `"boolean"` + default: boolean - - `Integer object { name, value, type }` + - `Integer object` A setting whose enforced value is a whole number; null means no limit is in force.
from line 511
- `name: "account_session_duration_seconds"` - - `"account_session_duration_seconds"` - - `value: number or null` - `type: optional "integer"` - - `"integer"` + default: integer - - `String object { name, value, type }` + - `String object` A setting whose enforced value is a single string; null means no value is configured.
from line 532
- `type: optional "string"` - - `"string"` + default: string - - `StringList object { name, value, type }` + - `StringList object` A setting whose enforced value is a list of strings.
from line 550
- `type: optional "string_list"` - - `"string_list"` + default: string_list - - `ProvisioningMode object { value, name, type }` + - `ProvisioningMode object` How organization members are provisioned, resolved to the enforced mode.
from line 577
- `name: optional "sso_provisioning_mode"` - - `"sso_provisioning_mode"` + default: sso_provisioning_mode - `type: optional "provisioning_mode"` - - `"provisioning_mode"` + default: provisioning_mode - - `DataRetention object { value, name, type }` + - `DataRetention object` The data retention periods in force, keyed by the type of data they apply to.
from line 593
administrator-configured retention period is in force for that data type; Anthropic's service defaults may still apply. - - `value: map[object { duration, timescale, type } or object { type } ]` + - `value: map[object or object]` - - `Fixed object { duration, timescale, type }` + - `Fixed object` A fixed retention window measured from each item's last activity.
from line 609
- `type: optional "fixed"` - - `"fixed"` + default: fixed - - `Indefinite object { type }` + - `Indefinite object` An indefinite retention period: data is kept with no time limit. - `type: optional "indefinite"` - - `"indefinite"` + default: indefinite - `name: optional "data_retention_periods"` - - `"data_retention_periods"` + default: data_retention_periods - `type: optional "data_retention"` - - `"data_retention"` + default: data_retention - `type: optional "effective_organization_settings"` - - `"effective_organization_settings"` + default: effective_organization_settings