/scopes
This resource is available only to principals with these entitlements: "ROLE_READ_SCOPE" "ROLE_BROKER_ADMIN"
Mount Point: /auth/api/v1/scopes/
GET
This operation is available only to principals with these entitlements: "ROLE_READ_SCOPE" "ROLE_BROKER_ADMIN"
Retrieve a list of scopes from the entire set of defined actions.
Parameters
| name | description | type | default |
|---|---|---|---|
| startIndex | The index number of the first item to be provided in the results. A null value is equivalent to 0. | query | |
| count | The maximum number of items to be provided in the results. A null value signifies no maximum. | query | |
| sortBy | Specifies how the results should be sorted. Allowed values are defined by com.unboundid.policy.models.Scope#getSortsByEnumValues(). A null value returns items in an unspecified order. | query | NAME_ASCENDING |
| filterBy | Specifies how filtering will occur. Allowed values are defined in com.unboundid.policy.models.Scope#getFiltersByEnumValues(). | query | |
| filter | user-supplied input used for filtering. | query | |
| excludesList | comma-separated list of ids to exclude from results. | query |
Response Body
| result: | scope |
| media types: | application/json |
Paged results of all requested scopes.
Status Codes
| code | description |
|---|---|
| 200 | Success |
POST
This operation is available only to principals with these entitlements: "ROLE_CREATE_SCOPE" "ROLE_BROKER_ADMIN"
Creates a model object.
Request Body
| element: | scope |
| media types: | application/json |
(no documentation provided)
Response Body
| result: | scope |
| media types: | application/json |
The created model object response.
Status Codes
| code | description |
|---|---|
| 201 | Success |
| 400 | Bad Request |