LOloket
Employer user

Reinstate or Revoke access to Loket for an employer user (clients)

Activity name : PatchManageEmployerUserLoketAccessByUserId

Metadata : No metadata

Defaults : No defaults

Reinstate or Revoke access to Loket.

This endpoint can also be used to block access to just the loket classic interface

Note: Only blocks access to "Loket2" en "Loket3" client. Conections for other clients are not affected by this action.

patch/v2/providers/employers/users/{userId}/access

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/users/{userId}/access
  • 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

action'RevokeAccess' | 'ReinstateAccess' | 'RevokeAccessLoketClassicOnly' | 'ReinstateAccessLoketClassicOnly'

indicates the action to perform.

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.