Skip to main content
POST
/
roles
Create a role
curl --request POST \
  --url https://api.sandbox.monite.com/v1/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "name": "<string>",
  "permissions": {
    "objects": [
      {
        "actions": [
          {
            "action_name": "read",
            "permission": "allowed"
          }
        ],
        "object_type": "comment"
      }
    ]
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "permissions": {
    "objects": [
      {
        "actions": [
          {
            "action_name": "read",
            "permission": "allowed"
          }
        ],
        "object_type": "comment"
      }
    ]
  },
  "status": "active"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
name
string
required

Role name

Required string length: 1 - 255
permissions
object
required

Access permissions

Response

Successful Response

id
string<uuid>
required

UUID role ID

created_at
string<date-time>
required

UTC datetime

updated_at
string<date-time>
required

UTC datetime

name
string
required

Role name

Minimum string length: 1
permissions
object
required

Access permissions

status
enum<string>
required

record status, 'active' by default

Available options:
active,
deleted