POST
/
api
/
roles
Create a role
curl --request POST \
  --url http://localhost:3000/api/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "permissions": []
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "permissions": [
      "<string>"
    ],
    "isSystem": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
Minimum string length: 1
​
slug
string
required
Minimum string length: 1
​
permissions
string[]

Response

Role created

​
success
boolean
Example:

true

​
message
string
​
data
object