Update a role

Authorization

AuthorizationBearer <token>

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

In: header

X-Nimbu-Site<token>

Identifier of the site context when authenticating with a personal access token.

In: header

Path Parameters

role_id*string

Role identifier

Header Parameters

Session-Token?string

Customer session token to apply ACL filtering

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

customers?array<string>

children?array<string>

parents?array<string>

Response Body

`application/json`

curl -X PUT "https://example.com/roles/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "_acl": {},
  "_owner": "string",
  "customers": [
    "string"
  ],
  "children": [
    "string"
  ],
  "parents": [
    "string"
  ]
}