Add user role

Creates a User Role mapping

PUT/appid-{appId}/{tenantId}/recipe/user/role

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

userIduserIdrequired

rolerolerequired

Responses

200The operation was successful

One of:

object

statusstatusOK

Allowed:OK

didUserAlreadyHaveRoleboolean

unknownRoleResponse

statusstring

Allowed:UNKNOWN_ROLE_ERROR

400error code 400

string

401error code 401

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

userIdstring*rolestring*

Request

curl -X PUT "/appid-{appId}/public/recipe/user/role" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "role": "admin"
}'

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

import requests

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

Response

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

"string"

"Invalid API key"

"Not Found"

"Internal Error"