Set custom role
PUT
/auth/roles/{name}
const url = 'https://sylve.lan:8181/api/auth/roles/example';const options = { method: 'PUT', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"privileges":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Role name
Request Body
Section titled “Request Body”Privileges
Media typeapplication/json
object
privileges
required
Array<string>
Examplegenerated
{ "privileges": [ "example" ]}Responses
Section titled “Responses”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"}