---
title: "Add an external tenant for an employer user"
method: PATCH
path: "/v2/providers/employers/users/{employerUserId}/configuredexternaltenant"
tags: ["External tenant employer user"]
---

# Add an external tenant for an employer user

`PATCH /v2/providers/employers/users/{employerUserId}/configuredexternaltenant`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/users/{employerUserId}/configuredexternaltenant`
- Auth: none required

__Activity name :__ PatchConfiguredExternalTenantByEmployerUserId

__Metadata :__  N/A.

__Defaults :__ N/A.

Modify an external tenant to the list of an configured external tenants for an employer user.
An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.

## Path parameters

- `employerUserId` string, uuid, required

## Headers

- `Authorization` string, required
- `Accept` string, required

## Request body

- ConfiguredExternalTenantObject
  - `externalTenant` object, nullable
    - `id` string, uuid: The unique identifier (GUID/UUID) of an external tenant. Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
    - `name` string: The user-friendly name of the external tenant
  - `externalUser` object, nullable
    - `id` string, uuid: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to successfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.

## Response `201`

Created

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `content` ConfiguredExternalTenantObject
    - `externalTenant` object, nullable
      - `id` string, uuid: The unique identifier (GUID/UUID) of an external tenant. Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
      - `name` string: The user-friendly name of the external tenant
    - `externalUser` object, nullable
      - `id` string, uuid: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to successfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)
