Skip to main content

Create Non-Employee Request​

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 string required

    Requested identity account name.

  • firstName string required

    Non-Employee's first name.

  • lastName string required

    Non-Employee's last name.

  • email string required

    Non-Employee's email.

  • phone string required

    Non-Employee's phone.

  • manager string required

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

  • sourceId string required

    Non-Employee's source id.

  • data object

    Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.

  • property name* string
  • startDate date-time required

    Non-Employee employment start date.

  • endDate date-time required

    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

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