Skip to content

Set custom role

PUT
/auth/roles/{name}
curl --request PUT \
--url https://sylve.lan:8181/api/auth/roles/example \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "privileges": [ "example" ] }'

Create a custom role or replace its privileges; built-in roles can’t be changed

name
required
string

Role name

Privileges

Media typeapplication/json
object
privileges
required
Array<string>
Examplegenerated
{
"privileges": [
"example"
]
}

Role Set

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}