Employer user

Link an existing employer user to this employer.

Activity name : PostLinkExistingEmployerUserByEmployerId

Metadata : No metadata endpoint

Defaults : No default values

Link an existing employer user to this employer.

post/v2/providers/employers/{employerId}/users/link

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/users/link
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Headers

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

Request body

userIdstring uuid

The unique identifier of an object (GUID/UUID)

departmentsstring[] nullable
copyAuthorizationsFromEmployerIdstring uuid nullable

The unique identifier of an object (GUID/UUID)

Example request

{
  "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "departments": [
    "904d6856-6034-4624-bcbc-886188c115c5"
  ],
  "copyAuthorizationsFromEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}

Response

Accepted

Example response

{
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "loginMethod": {
      "key": 3,
      "value": "Only via SSO"
    },
    "personalDetails": {
      "firstName": "Susan",
      "initials": "S.L.",
      "prefix": "van",
      "lastName": "Bergen"
    },
    "contactInformation": {
      "placeOfEmployment": "Amsterdam office",
      "phoneNumber": "+31 13-1234567",
      "emailAddress": "info@loket.nl"
    },
    "userSpecifiedRole": {
      "key": 3,
      "value": "Salarisadministrateur"
    },
    "userCustomSpecifiedRole": "Secretariaat medewerker",
    "accessStatus": {
      "key": 3,
      "value": "Has access to Client"
    },
    "azureActiveDirectory": {
      "tenant": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "description": "Customer X Azure AD"
      },
      "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
    },
    "userName": "User42",
    "dateTimeLastLogin": "2021-01-19",
    "dateTimeCreation": "2020-01-19"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.