Skip to main content
POST
/
v1
/
permissions.createRole
Create role
curl --request POST \
  --url https://api.unkey.dev/v1/permissions.createRole \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "dns.records.manager",
  "description": "dns.records.manager can read and write dns records for our domains."
}
'
{
  "roleId": "role_123"
}

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

The unique name of your role.

Required string length: 3 - 256
Example:

"dns.records.manager"

​
description

Explain what this role does. This is just for your team, your users will not see this.

Required string length: 3 - 256
Example:

"dns.records.manager can read and write dns records for our domains."

Response

Sucessfully created a role

​
roleId
string
required

The id of the role. This is used internally

Example:

"role_123"