LOloket
Provider user

Resend or Revoke an invite for a provider user

Activity name : PatchProviderUserInviteByUserId

Metadata : Possible options for fields of the type 'metadata' can be acquired via /v2/providers/users/metadata

Defaults : No defaults

Resend or Revoke an invite for an provider user.

patch/v2/providers/users/{userId}/invite

Request

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

indicates the action to perform.

Example request

{
  "resendInformation": {
    "destinationForSecret": "0612345678",
    "emailAddress": "info@loket.nl",
    "providerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
}

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",
    "authorizationSet": {
      "key": 3,
      "value": "Salarisadministrateur"
    }
  }
}

Changes

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