Create New Role
Request
POST <REST API URL>/roles?fields=string
Parameter | Description |
---|---|
fields | Optional. Returns only the specified subset of the fields for each Role. Use Fields Syntax to define the subset. |
Request Body
role
{
"id": string,
"aliases": [alias, ...],
"key": string,
"name": string,
"description": string,
"permissions": [permission, ...],
"immutable": boolean
}
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"id": string,
"aliases": [alias, ...],
"key": string,
"name": string,
"description": string,
"permissions": [permission, ...],
"immutable": boolean
}
Last modified: 22 October 2024