OAuth Resource Object
Contains information about an OAuth resource (OAuth scope).
This object is used by the following operations:
- Any operations that use the ResourceHierarchy object
- Any operations that use the GrantResourceScope object
- any object that has child resources (see below)
The properties included in the Resource object are listed below.
| Property | Type | Description |
|---|---|---|
| Name | string | The name of the resource. Required. |
| ShortDescription | string | Short description of the resource. Required. |
| LongDescription | string | Long description of the resource. Optional. |
| ResourcePath | string | Path for the resource. If there is no hierarchy, the value is the same as the name of the resource. If there is a hierarchy, this field shows the resource's relative position in the hierarchy. |
| ChildResources | Resource[ ] | Information about one or more child resources, if applicable. |
| SupportedGrantTypes | string[ ] |
Information about grant types supported for the resource. One or more. |
| ClaimNames | string[ ] |
Information about claims supported for the resource. One or more. |
| DefaultResource | boolean | If included and set to true, indicates whether the current resource is the default resource. Default: false. |
| UserAuthorizationRequired | boolean | Indicates whether user authorization is required. Default: true. |