Class: Anthropic::Resources::Beta::Organization::ComplianceSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/organization/compliance_settings.rb,
sig/anthropic/resources/beta/organization/compliance_settings.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ComplianceSettings

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ComplianceSettings.

Parameters:



72
73
74
 
# File 'lib/anthropic/resources/beta/organization/compliance_settings.rb', line 72

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Anthropic::Models::Beta::Organization::BetaComplianceSettings

Retrieve your organization's Compliance Settings.

Compliance Settings is a singleton resource: there is exactly one per organization, addressed without an identifier. The state field reflects whether the Compliance API is enabled. An organization with a parent organization reads the state inherited from the parent's configuration.

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
 
# File 'lib/anthropic/resources/beta/organization/compliance_settings.rb', line 22

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "v1/organizations/compliance_settings?beta=true",
    model: Anthropic::Beta::Organization::BetaComplianceSettings,
    options: params[:request_options]
  )
end

#update(state:, request_options: {}) ⇒ Anthropic::Models::Beta::Organization::BetaComplianceSettings

Update your organization's Compliance Settings.

Setting state to enabled turns on the Compliance API and begins capturing organization activity events. Setting it to disabled turns both off. state reflects whether the Compliance API is enabled.

A request that sets state to its current value succeeds and leaves the resource unchanged. A disabled request stays in effect until a later enabled request or the organization's next provisioning action that enables Access Transparency: enabling Access Transparency also enables the Compliance API, which serves its activity events, so such provisioning (including re-runs) re-enables the Compliance API even after a disabled request. Automated provisioning never disables compliance settings.

Some parameter documentations has been truncated, see Models::Beta::Organization::ComplianceSettingUpdateParams for more details.

Parameters:

Returns:

See Also:



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/anthropic/resources/beta/organization/compliance_settings.rb', line 58

def update(params)
  parsed, options = Anthropic::Beta::Organization::ComplianceSettingUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/organizations/compliance_settings?beta=true",
    body: parsed,
    model: Anthropic::Beta::Organization::BetaComplianceSettings,
    options: options
  )
end