Resource Object
Contains information about a resource, such as a scope, defined for a business organization.
This object is used by the following operations:
- POST /api/businesses/{BusinessID}/resources (in request and response)
- PUT /api/businesses/resources/{ResourceID} (in request and response)
- DELETE /api/businesses/resources/{ResourceID} (in response)
- GET /api/businesses/resources/{ResourceID} (in response)
- Operations that reference the BusinessResources object
The properties included in the Resource object are listed below.
| Property | Type | Description |
|---|---|---|
| ResourceID | string | The unique ID for the resource; for example, the ScopeID. |
| Name | string | The name of the resource. |
| ShortDescription | string | A short description of the resource |
| LongDescription | string | A long description of the resource, if applicable. |
| Visibility | string | The visibility setting for this resource. For a list of valid values, see Visibility Settings. |
| ParentResourceID | string | The unique ID for the parent resource, if applicable. |
| SandboxAnonymousAccessAllowed | boolean | Indicates whether anonymous access is allowed to the Sandbox implementation. |
| ProductionAnonymousAccessAllowed | boolean | Indicates whether anonymous access is allowed to the Live implementation. |
| ResourcePath | string | Path to the resource. |
| OAuthGrantDefaultResource | boolean | Indicates whether it is an OAuth Grant resource. |
| OAuthGrantUserAuthorizationRequired | boolean | For an OAuth Grant resource, indicates whether user authorization is required. |
| BusinessID | string | The unique ID for a specific business organization on the platform. |