Skip to main content

Requestable Objects List

GET 
/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​

Query Parameters

    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.
    Example: e7eab60924f64aa284175b9fa3309599
    types RequestableObjectType[]

    Possible values: [ACCESS_PROFILE, ROLE, ENTITLEMENT]

    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.

    Example: ROLE,ACCESS_PROFILE
    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.

    Example: Finance Role
    statuses RequestableObjectRequestStatus[]

    Possible values: [AVAILABLE, PENDING, ASSIGNED, null]

    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.

    Example: [ASSIGNED, PENDING]
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    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.

    Example: true
    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

    Example: name sw "bob"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: name

    Example: name

Responses​

List of requestable objects

Schema
  • Array [
    • id string

    Id of the requestable object itself

    name string

    Human-readable display name of the requestable object

    created date-time

    The time when the requestable object was created

    modified date-timenullable

    The time when the requestable object was last modified

    description stringnullable

    Description of the requestable object.

    type RequestableObjectType

    Possible values: [ACCESS_PROFILE, ROLE, ENTITLEMENT]

    The currently supported requestable object types.

    requestStatus objectnullable

    Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by identity-id. AVAILABLE indicates the object is available to request. PENDING indicates the object is unavailable because the identity has a pending request in flight. ASSIGNED indicates the object is unavailable because the identity already has the indicated role or access profile. If identity-id is not specified (allowed only for admin users), then status will be AVAILABLE for all results.

    identityRequestId stringnullable

    If requestStatus is PENDING, indicates the id of the associated account activity.

    ownerRef objectnullable
    type string

    The type can only be IDENTITY. This is read-only

    id string

    Identity id.

    name string

    Human-readable display name of identity. This is read-only

    email string

    Email address of identity. This is read-only

    requestCommentsRequired boolean

    Whether the requester must provide comments when requesting the object.

  • ]
Loading...