License Object
Contains information about an API license defined for a business.
This object is used by the following operations:
- POST /api/licenses (to add a license: in request and response)
- PUT /api/licenses/{LicenseID} (to update a license)
- DELETE /api/licenses/{LicenseID} (to delete a license)
- Operations that reference the APIVisibilityScope object
- Operations that reference the APIVersionAutoConnectLicenseDetail object
- Operations that reference the VisibilityContractDetails object
- Operations that reference the ReferencedObjects object
The properties included in the License object are listed below.
| Property | Type | Description |
|---|---|---|
| LicenseID | string | The unique ID for a specific license. |
| Name | string | Text name for the license. |
| Description | string | Description of the license. |
| Visibility | string | Visibility setting for the license. |
| SandboxAccessAutoApproved | boolean | Indicates whether sandbox access is automatically approved. |
| ProductionAccessAutoApproved | boolean | Indicates whether production access is automatically approved. |
| LicenseParts | LicenseParts | Contains details about one or more licenses. |
| BusinessID | string | The unique ID for a specific business organization on the platform. |
| Active | boolean | Indicates whether the license is active. Defaults to true. |
| Environment | string[ ] | Indicates one or more environments the license applies to. |
| AgreementDetails | AgreementDocument[ ] |
Contains information about a platform legal agreement document. One or more. |