v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB

Linked departments

Link or unlink departments from an user.

Activity name: PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId

This endpoint enables the user to link or unlink multiple 'linkages' with one call.

patch/v2/providers/employers/{employerId}/users/{userId}/departments

employerIdstring uuid required

The unique identifier of the employer

userIdstring uuid required

The unique identifier of an user

Authorizationstring required

Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required

Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

departmentIdstring uuid

The unique identifier (GUID/UUID) of the department

action'link' | 'unlink'

The action to perform.

hasAccessToSubDepartmentsboolean

Indicates whether the user will have access to departments that are configured as sub-departments of the selected department.

[
  {
    "departmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
]