Skip to main content

Get a non-employee approval item detail

GET 
/non-employee-approvals/:id

Gets a non-employee approval item detail. There are two contextual uses for this endpoint:

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

Request​

Path Parameters

    id stringrequired

    Non-Employee approval item id (UUID)

    Example: e136567de87e4d029e60b3c3c55db56d

Query Parameters

    include-detail boolean

    The object nonEmployeeRequest will not be included detail when set to false. Default value is true

    Example: true

Responses​

Non-Employee approval item object.

Schema
    id UUID

    Non-Employee approval item id

    approver object

    Reference to the associated Identity

    type NonEmployeeIdentityDtoType

    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

    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

    Non-Employee request associated to this approval

    id UUID

    Non-Employee request id.

    requester object
    type NonEmployeeIdentityDtoType

    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.

    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.

    schemaAttributes object[]

    List of schema attributes associated with this non-employee source.

  • Array [
    • id UUID

    Schema Attribute Id

    system boolean

    True if this schema attribute is mandatory on all non-employees sources.

    modified date-time

    When the schema attribute was last modified.

    created date-time

    When the schema attribute was created.

    type NonEmployeeSchemaAttributeTyperequired

    Possible values: [TEXT, DATE, IDENTITY]

    Enum representing the type of data a schema attribute accepts.

    label stringrequired

    Label displayed on the UI for this schema attribute.

    technicalName stringrequired

    The technical name of the attribute. Must be unique per source.

    helpText string

    help text displayed by UI.

    placeholder string

    Hint text that fills UI box.

    required boolean

    If true, the schema attribute is required for all non-employees in the source

  • ]
    • data object

    Attribute blob/bag for a non-employee.

    property name* string
    approvalStatus ApprovalStatus

    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

    Non-Employee employment start date.

    endDate date

    Non-Employee employment end date.

    modified date-time

    When the request was last modified.

    created date-time

    When the request was created.

Loading...