/resources
Mount Point: /auth/api/v1/resources/
GET
Retrieve a list of resources from the entire set of defined resources.
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.Resource#getSortsByEnumValues(). A null value returns items in an unspecified order. | query | NAME_ASCENDING |
| includeGroups | true to return resource groups in the results false to return non-group results. | query | true |
| filterBy | Specifies how filtering will occur. Allowed values are defined in com.unboundid.policy.models.Resource#getFiltersByEnumValues(). | query | |
| filter | user-supplied input used for filtering. | query | |
| excludesList | comma-separated list of ids to exclude from results. | query | |
| urnFilter | optional urn filter to apply in addition to the filtering specified by filterBy and filterInput parameters. | query |
Response Body
| result: | resource |
| media types: | application/json |
Paged results of all requested resources.
Status Codes
| code | description |
|---|---|
| 200 | Success |
POST
Creates a resource.
Request Body
| element: | resource |
| media types: | application/json |
The object to be created.
Response Body
| result: | resource |
| media types: | application/json |
The created resource.
Status Codes
| code | description |
|---|---|
| 201 | Success |
| 400 | Bad Request |