Skip to main content

List Non-Employee Requests​

This gets a list of non-employee requests. There are two contextual uses for the requested-for path parameter:

  1. The user has the role context of idn:nesr:read, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
  2. The current user is an account manager, in which case "me" should be provided as the requested-for value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.
Query Parameters
  • 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.

  • 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
  • requested-for string required

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

    Example: e136567de87e4d029e60b3c3c55db56d
  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate

    Example: created,approvalStatus
  • filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: sourceId: eq Example: sourceId eq "2c91808568c529c60168cca6f90c1313"

    Example: sourceId eq "2c91808568c529c60168cca6f90c1313"
Responses

List of non-employee request objects.

Schema array
  • id UUID

    Non-Employee source id.

  • sourceId string

    Source Id associated with this non-employee source.

  • name string

    Source name associated with this non-employee source.

  • description string

    Source description associated with this non-employee source.

  • accountName string

    Requested identity account name.

  • firstName string

    Non-Employee's first name.

  • lastName string

    Non-Employee's last name.

  • email string

    Non-Employee's email.

  • phone string

    Non-Employee's phone.

  • manager string

    The account ID of a valid identity to serve as this non-employee's manager.

  • nonEmployeeSource object
  • id UUID

    Non-Employee source id.

  • sourceId string

    Source Id associated with this non-employee source.

  • name string

    Source name associated with this non-employee source.

  • description string

    Source description associated with this non-employee source.

  • data object

    Attribute blob/bag for a non-employee.

  • property name* string
  • approvalItems object[]

    List of approval item for the request

  • id UUID

    Non-Employee approval item id

  • approver object

    Reference to the associated Identity

  • type 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 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.

  • approvalStatus string

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

    Enum representing the non-employee request approval status

  • comment string

    comment of requester

  • completionDate date-time

    When the request was completely approved.

  • startDate date-time

    Non-Employee employment start date.

  • endDate date-time

    Non-Employee employment end date.

  • modified date-time

    When the request was last modified.

  • created date-time

    When the request was created.

Loading...