Get Compliance Settings

BetaComplianceSettings Beta.Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)

GET/v1/organizations/compliance_settings

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

ComplianceSettingRetrieveParams parameters

Returns

class BetaComplianceSettings { Type = "compliance_settings"; State; }

JsonElement Type = "compliance_settings"

required BetaComplianceSettingsState State

Whether the Compliance API is enabled for this organization.

One of the following:

class BetaComplianceSettingsStateEnabled { Type = "enabled"; }

JsonElement Type = "enabled"

class BetaComplianceSettingsStateDisabled { Type = "disabled"; }

JsonElement Type = "disabled"

Get Compliance Settings

ComplianceSettingRetrieveParams parameters = new();

var betaComplianceSettings = await client.Beta.Organization.ComplianceSettings.Retrieve(parameters);

Console.WriteLine(betaComplianceSettings);

Response 200

{
  "state": {
    "type": "enabled"
  },
  "type": "compliance_settings"
}

Returns Examples

Response 200

{
  "state": {
    "type": "enabled"
  },
  "type": "compliance_settings"
}