Skip to content

Create Role

POST
/api/v1/permissions/roles
curl --request POST \
--url https://example.com/api/v1/permissions/roles \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "comment": "example" }'

Create a new role.

Args: request: Role creation details

Returns: PermissionOperationResponse with operation result

Raises: HTTPException: If role creation fails

X-Environment-Id
Any of:
string
Media typeapplication/json
CreateRoleRequest

Request to create a new role.

object
name
required
Name

Role name

string
comment
Any of:
string
Examplegenerated
{
"name": "example",
"comment": "example"
}

Successful Response

Media typeapplication/json
PermissionOperationResponse

Response for permission operations.

object
success
required
Success

Whether the operation was successful

boolean
message
required
Message

Operation result message

string
details
Any of:
object
key
additional properties
any
Examplegenerated
{
"success": true,
"message": "example",
"details": {}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}