SPB Git

Repository Public

compliance_settings.md 4.9 KB 225 lines markdown

1---2title: Compliance Settings3url: https://platform.claude.com/docs/en/api/beta/organization/compliance_settings4---56# Compliance Settings78## Get Compliance Settings910**GET** `/v1/organizations/compliance_settings`1112Retrieve your organization's Compliance Settings.1314Compliance Settings is a singleton resource: there is exactly one per15organization, addressed without an identifier. The `state` field reflects16whether the Compliance API is enabled. An organization with a parent17organization reads the state inherited from the parent's configuration.1819### Returns2021- `BetaComplianceSettings object`2223  - `type: "compliance_settings"`2425    default: compliance_settings2627  - `state: BetaComplianceSettingsState`2829    Whether the Compliance API is enabled for this organization.3031    - `BetaComplianceSettingsStateEnabled object`3233      - `type: "enabled"`3435        default: enabled3637    - `BetaComplianceSettingsStateDisabled object`3839      - `type: "disabled"`4041        default: disabled4243### Example4445```bash46curl https://api.anthropic.com/v1/organizations/compliance_settings \47    -H 'anthropic-version: 2023-06-01' \48    -H "X-Api-Key: $ANTHROPIC_API_KEY"49```5051#### Response (200)5253```json54{55  "state": {56    "type": "enabled"57  },58  "type": "compliance_settings"59}60```6162## Update Compliance Settings6364**POST** `/v1/organizations/compliance_settings`6566Update your organization's Compliance Settings.6768Setting `state` to `enabled` turns on the Compliance API and begins69capturing organization activity events. Setting it to `disabled` turns70both off. `state` reflects whether the Compliance API is enabled.7172A request that sets `state` to its current value succeeds and leaves the73resource unchanged. A `disabled` request stays in effect until a later74`enabled` request or the organization's next provisioning action that75enables Access Transparency: enabling Access Transparency also enables76the Compliance API, which serves its activity events, so such77provisioning (including re-runs) re-enables the Compliance API even78after a `disabled` request. Automated provisioning never disables79compliance settings.8081### Body parameters8283- `state: BetaComplianceSettingsStateParam`8485  Desired state. Accepts the string shorthand "enabled" or "disabled" in place of the object form; the response always returns the canonical object form.8687  - `BetaComplianceSettingsStateEnabledParam object`8889    - `type: "enabled"`9091  - `BetaComplianceSettingsStateDisabledParam object`9293    - `type: "disabled"`9495### Returns9697- `BetaComplianceSettings object`9899  - `type: "compliance_settings"`100101    default: compliance_settings102103  - `state: BetaComplianceSettingsState`104105    Whether the Compliance API is enabled for this organization.106107    - `BetaComplianceSettingsStateEnabled object`108109      - `type: "enabled"`110111        default: enabled112113    - `BetaComplianceSettingsStateDisabled object`114115      - `type: "disabled"`116117        default: disabled118119### Example120121```bash122curl https://api.anthropic.com/v1/organizations/compliance_settings \123    -H 'Content-Type: application/json' \124    -H 'anthropic-version: 2023-06-01' \125    -H "X-Api-Key: $ANTHROPIC_API_KEY" \126    -d '{127          "state": {128            "type": "enabled"129          }130        }'131```132133#### Response (200)134135```json136{137  "state": {138    "type": "enabled"139  },140  "type": "compliance_settings"141}142```143144## Domain types145146### Beta Compliance Settings147148- `BetaComplianceSettings object`149150  - `type: "compliance_settings"`151152    default: compliance_settings153154  - `state: BetaComplianceSettingsState`155156    Whether the Compliance API is enabled for this organization.157158    - `BetaComplianceSettingsStateEnabled object`159160      - `type: "enabled"`161162        default: enabled163164    - `BetaComplianceSettingsStateDisabled object`165166      - `type: "disabled"`167168        default: disabled169170### Beta Compliance Settings State171172- `BetaComplianceSettingsState = BetaComplianceSettingsStateEnabled or BetaComplianceSettingsStateDisabled`173174  - `BetaComplianceSettingsStateEnabled object`175176    - `type: "enabled"`177178      default: enabled179180  - `BetaComplianceSettingsStateDisabled object`181182    - `type: "disabled"`183184      default: disabled185186### Beta Compliance Settings State Disabled187188- `BetaComplianceSettingsStateDisabled object`189190  - `type: "disabled"`191192    default: disabled193194### Beta Compliance Settings State Disabled Param195196- `BetaComplianceSettingsStateDisabledParam object`197198  - `type: "disabled"`199200### Beta Compliance Settings State Enabled201202- `BetaComplianceSettingsStateEnabled object`203204  - `type: "enabled"`205206    default: enabled207208### Beta Compliance Settings State Enabled Param209210- `BetaComplianceSettingsStateEnabledParam object`211212  - `type: "enabled"`213214### Beta Compliance Settings State Param215216- `BetaComplianceSettingsStateParam = BetaComplianceSettingsStateEnabledParam or BetaComplianceSettingsStateDisabledParam`217218  - `BetaComplianceSettingsStateEnabledParam object`219220    - `type: "enabled"`221222  - `BetaComplianceSettingsStateDisabledParam object`223224    - `type: "disabled"`225
Files main
Menu

Theme