Skip to main content

Create Non-Employee Request

POST 
/non-employee-requests

This request will create a non-employee request and notify the approver. Requires role context of idn:nesr:create or the user must own the source.

Request​

Body

required

Non-Employee creation request body

    accountName stringrequired

    Requested identity account name.

    firstName stringrequired

    Non-Employee's first name.

    lastName stringrequired

    Non-Employee's last name.

    email stringrequired

    Non-Employee's email.

    phone stringrequired

    Non-Employee's phone.

    manager stringrequired

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

    sourceId stringrequired

    Non-Employee's source id.

    data

    object

    Additional attributes for a non-employee. Up to 10 custom attributes can be added.

    property name* string
    startDate date-timerequired

    Non-Employee employment start date.

    endDate date-timerequired

    Non-Employee employment end date.

Responses​

Non-Employee request creation object

Schema

    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

    Additional attributes for a non-employee. Up to 10 custom attributes can be added.

    property name* string

    approvalItems

    object[]

    List of approval item for the request

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

  • ]

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