Skip to main content

Get List of Non-Employee Approval Requests

GET 

/non-employee-approvals

This gets a list of non-employee approval requests. There are two contextual uses for this endpoint:

  1. The user has the role context of idn:nesr:read, in which case they can list the approvals for any approver.
  2. The user owns the requested approval.

Request

Query Parameters

    requested-for string

    The identity for whom the request was made. me indicates the current user.

    Example: 2c91808280430dfb0180431a59440460
    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

    Default value: 0

    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:

    approvalStatus: eq

    Example: approvalStatus eq "Pending"
    sorters comma-separated

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

    Sorting is supported for the following fields: created, modified

    Example: created

Responses

List of approval items.

Schema

  • Array [

  • id UUID

    Non-Employee approval item id

    approver

    object

    Reference to the associated Identity

    type NonEmployeeIdentityDtoType (string)

    Possible values: [GOVERNANCE_GROUP, IDENTITY]

    Identifies if the identity is a normal identity or a governance group

    id string

    Identity id

    accountName string

    Requested identity account name

    approvalStatus ApprovalStatus (string)

    Possible values: [APPROVED, REJECTED, PENDING, NOT_READY, CANCELLED]

    Enum representing the non-employee request approval status

    approvalOrder float

    Approval order

    comment string

    comment of approver

    modified date-time

    When the request was last modified.

    created date-time

    When the request was created.

    nonEmployeeRequest

    object

    id UUID

    Non-Employee request id.

    requester

    object

    type NonEmployeeIdentityDtoType (string)

    Possible values: [GOVERNANCE_GROUP, IDENTITY]

    Identifies if the identity is a normal identity or a governance group

    id string

    Identity id

  • ]

Loading...