Skip to content

Create a role​

POST
/roles

Authorizations​

bearerToken|siteContext
bearerToken

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

TypeHTTP (bearer)
+
siteContext

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

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Header Parameters

Session-Token

Customer session token to apply ACL filtering

Typestring

Request Body​

application/json
JSON
{
"name": "string",
"customers": [
"string"
],
"children": [
"string"
],
"parents": [
"string"
]
}

Responses​

role created

application/json
JSON
{
"id": "string",
"name": "string",
"created_at": "string",
"updated_at": "string",
"description": "string",
"customers": [
"string"
],
"children": [
"string"
],
"parents": [
"string"
],
"_acl": {
"additionalProperties": [
]
},
"_owner": "string"
}

Playground​

Authorization
Headers
Body

Samples​