Provider user

Create an SSO or Azure AD provider user for an provider

Activity name : PostProviderUserByProviderId

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

Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.

Add an SSO or Azure AD user for an provider.

post/v2/providers/{providerId}/users

Request

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

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

hasAccessToPayrollingTestDataboolean

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

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "loginMethod": {
    "key": 3,
    "value": "Only via SSO"
  },
  "personalDetails": {
    "initials": "S.L.",
    "prefix": "van",
    "lastName": "Bergen"
  },
  "contactInformation": {
    "placeOfEmployment": "Amsterdam office",
    "phoneNumber": "+31 13-1234567",
    "emailAddress": "info@loket.nl"
  },
  "azureActiveDirectory": {
    "tenant": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
    },
    "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "userName": "User123"
  },
  "ssoAccount": {
    "userName": "Customer X Azure AD",
    "password": "Password%6"
  }
}

Response

Created

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.