Policy Object
Contains information about a policy that is enforced for an API version. Depending on where this appears, the policy might be enforced at the service level or at the operation level.
Note: For specific information regarding which policies are available/required, refer to the GET /api/policies operation.
This object is used by the following operations:
- Operations that reference the Policies object
- Operations that reference the ApiPolicies object (in 2020.2.0 and later)
- Operations that reference the ApiOperationPolicy object (in 2020.2.0 and later)
The properties included in the Policy object are listed below. Properties are optional unless otherwise noted.
| Property | Type | Description |
|---|---|---|
| PolicyKey | string | The unique key for a specific policy. Required when saving or updating an API version. |
| Name | string | The display name for the policy. |
| Description | string | The plain text description of the policy. |
| PolicyType | string |
The type of policy. Possible values:
Required when saving or updating an API version. |
| PolicySubType | string | For internal use only: a sub-type for the policy, if applicable. |
| BusinessID | string | The unique ID for a specific business organization on the platform. |
| PolicyConfiguration | string | XML metadata containing information about the policy definition and configuration. |