Requestable Objects List
GET {{baseUrl}}/requestable-objects
This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using identity-id query param. Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
identity-id | string | If present, the value returns only requestable objects for the specified identity. |
- Admin users can call this with any identity ID value.
- Non-admin users can only specify me or pass their own identity ID value.
- If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. |
|
types
| string | | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. | |term
| string | | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the filter query parameter will be ignored. | |statuses
| string | | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an identity-id parameter. Additional statuses may be added in the future without notice. | |limit
| number | | Max number of results to return. See V3 API Standard Collection Parameters for more information. | |offset
| number | | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | |count
| boolean | | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| filters
| string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, in
name: eq, in, sw
|
| sorters
| string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"2c9180835d2e5168015d32f890ca1581","name":"Applied Research Access","created":"2017-07-11T18:45:37.098Z","modified":"2018-06-25T20:22:28.104Z","description":"Access to research information, lab results, and schematics.","type":"ACCESS_PROFILE","requestStatus":"AVAILABLE","identityRequestId":null,"ownerRef":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e","name":"Alison Ferguso","email":"alison.ferguso@identitysoon.com"},"requestCommentsRequired":false},{"id":"2c9180835d2e5168015d32f890ca1581","name":"Applied Research Access","created":"2017-07-11T18:45:37.098Z","modified":"2018-06-25T20:22:28.104Z","description":"Access to research information, lab results, and schematics.","type":"ACCESS_PROFILE","requestStatus":"AVAILABLE","identityRequestId":null,"ownerRef":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e","name":"Alison Ferguso","email":"alison.ferguso@identitysoon.com"},"requestCommentsRequired":false}]