Add user tenant association

Add user’s association with the tenant.

User will be added to the tenant based on the url prefix of the request.

Note: To associate a user to a tenant, the tenant must be in the same database and user must already exist in the app

POST/appid-{appId}/{tenantId}/recipe/multitenancy/tenant/user

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Path parameters

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

recipeUserIduserIdrequired

Responses

200Association result

One of:

object

statusstatusOKrequired

Allowed:OK

wasAlreadyAssociatedbooleanrequired

object

statusstringrequired

Allowed:UNKNOWN_USER_ID_ERROREMAIL_ALREADY_EXISTS_ERRORPHONE_NUMBER_ALREADY_EXISTS_ERRORTHIRD_PARTY_USER_ALREADY_EXISTS_ERROR

object

statusstring

Allowed:ASSOCIATION_NOT_ALLOWED_ERROR

reasonstring

400error code 400

string

401error code 401

string

402error code 402

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

tenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

recipeUserIdstring*

Request

curl -X POST "/appid-{appId}/public/recipe/multitenancy/tenant/user" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483"
}'

const response = await fetch("/appid-{appId}/public/recipe/multitenancy/tenant/user", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483"
})
});

import requests

response = requests.post(
    "/appid-{appId}/public/recipe/multitenancy/tenant/user",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483"
},
)

Response

{
  "status": "OK",
  "wasAlreadyAssociated": true
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"