Skip to main content

Patch Non-Employee Record​

This request will patch a non-employee record. There are two contextual uses for this endpoint:

  1. The user has the role context of idn:nesr:update, in which case they update all available fields.
  2. The user is owner of the source, in this case they can only update the end date.
Path Parameters
  • id string required

    Non-employee record id (UUID)

    Example: ef38f94347e94562b5bb8424a56397d8
Request Body array required

A list of non-employee update operations according to the JSON Patch standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.

  • op string required

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

  • path string required

    A string JSON Pointer representing the target path to an element to be affected by the operation

  • value object

    The value to be used for the operation, required for "add" and "replace" operations

    anyOf
  • string
Responses

A patched non-employee record.

Schema
  • id UUID

    Non-Employee record 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.

  • sourceId string

    Non-Employee's source id.

  • data object

    Attribute blob/bag for a non-employee.

  • property name* string
  • 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...