VisibilityContract Object
Contains information about a visibility contract between a resource and a viewer. It includes the API version, the group that has visibility, and the visibility permissions—one or more specific licenses, or unlimited visibility.
This object is used by the following operations:
- Save private viewer scope: PUT /api/apis/versions/{APIVersionID}/viewers/{ViewerID}
- Invite private viewer with scope: POST /api/apis/versions/{APIVersionID}/viewers
The properties included in the VisibilityContract object are listed below.
| Property | Type | Description |
|---|---|---|
| ResourceID | string |
The unique ID for a specific resource; for example, the ScopeID or the APIVersionID. In the context of POST /api/apis/versions/{APIVersionID}/viewers it is the APIVersionID. |
| ViewerID | string | The GroupID of a group that has visibility permission to view the API. |
| ViewerType | string | Indicates the type for the ViewerID. The only valid value is group. |
| RestrictedScope | boolean | Indicates whether the specified viewer has restricted scope for the specified resource. |
| LicenseID | LicenseID | The unique ID for a specific license. |