Skip to content
Authrim

Create role

POST
/api/admin/roles
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "custom_viewer", "description": "Custom viewer role.", "permissions": [ "users:read" ], "hierarchy_level": 0 }'

Creates a custom tenant role after validating the name, permission strings, optional parent role, and hierarchy-management permissions.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
>= 2 characters <= 50 characters
description
string
permissions
required
Array<string>
inherits_from
string
parent_role_id
string
hierarchy_level
integer
key
additional properties
Example 
{
  "name": "custom_viewer",
  "description": "Custom viewer role.",
  "permissions": [
    "users:read"
  ],
  "hierarchy_level": 0
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Role creation response.

Media type application/json
object
role_id
required
string
name
required
string
description
required
string | null
permissions
required
Array<string>
parent_role_id
required
string | null
inherits_from
required
string | null
hierarchy_level
required
integer
is_system
required
boolean
created_at
required
string format: date-time
key
additional properties
Example 
{
  "role_id": "role_custom_viewer",
  "name": "custom_viewer",
  "description": "Custom viewer role.",
  "permissions": [
    "users:read"
  ],
  "parent_role_id": null,
  "inherits_from": null,
  "hierarchy_level": 0,
  "is_system": false,
  "created_at": "2026-06-20T00:00:00.000Z"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}