Create or update role

Creates a role with permissions, can also be used to add permissions to a role

PUT/appid-{appId}/recipe/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.

Header parameters

ridstring

cdi-versionstring

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

Request body

application/json

rolerolerequired

permissionsstring[]

Responses

200The operation was successful

statusstatusOK

Allowed:OK

createdNewRoleboolean

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

ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

Request body

Request

curl -X PUT "/appid-{appId}/recipe/role" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "admin",
  "permissions": [
    "permission"
  ]
}'

const response = await fetch("/appid-{appId}/recipe/role", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "role": "admin",
  "permissions": [
    "permission"
  ]
})
});

import requests

response = requests.put(
    "/appid-{appId}/recipe/role",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "role": "admin",
  "permissions": [
    "permission"
  ]
},
)

Response

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

"string"

"Invalid API key"

"Not Found"

"Internal Error"