LOloket
Employer user

Edit the details of an employer user user

Activity name : PutEmployerUserByUserId

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.

Edit the details of an employer user

put/v2/providers/employers/users/{userId}

Request

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

Path parameters

userIdstring uuid required

The unique identifier of an user

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

idstring uuid

The unique identifier of an object (GUID/UUID)

userCustomSpecifiedRolestring nullable

Further specification of the user role.

hasAccessToPayrollingTestDataboolean

Indicates if the user has access to data for payrolling test years

hasMultiFactorAuthenticationboolean

Indicates if the user has multi factor authentication enabled

Can only be changed from true to false.

twoFactorAuthenticationRequiredboolean

Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO

userNamestring nullable

The username

isDepartmentManagerboolean

Indicates if the user is a department manager

isLinkedToMultipleEmployersboolean

Indicates if the user has access to multiple employer.

hasIntegrationsboolean

Indicates if the user has integrations with clients other that Loket. This means that another application can call the loket API using this user.

hasConnectedApplicationsboolean

Indicates if the user has connected applications.In this case a conection was made where loket can call the external softwares api to read and/or write data for that system.

dateTimeLastLoginstring date-time nullable

The date on which the user loged in for the last time

dateTimeCreationstring date-time

The date on which the user was created

Example request

{
  "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"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "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.