Skip to content
autom8y

Create Role

POST
/auth/roles

Create a new role.

Requires admin:roles permission.

Args: request: Role creation details auth_data: Authenticated user and payload db: Database session

Returns: Created role with empty permissions list

Raises: 400: Role name already exists in business 403: User lacks admin:roles permission

Request Body required

Section titled “Request Body required ”
CreateRoleRequest

Create role request.

object
name
required
Name

Role name

string
>= 1 characters <= 100 characters
description
Any of:
string
business_id
required
Business Id

Business/tenant UUID

string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

RoleResponse

Role response.

object
id
required
Id
string
name
required
Name
string
business_id
required
Business Id
string
description
Any of:
string
permissions
Permissions
Array<object>
default:
PermissionResponse

Permission response.

object
id
required
Id
string
name
required
Name
string
description
Any of:
string
created_at
required
Created At
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

400

Section titled “400 ”

Bad Request

ErrorResponse

Error response.

object
error
required
Error

Error code

string
message
required
Message

Error message

string

403

Section titled “403 ”

Forbidden

ErrorResponse

Error response.

object
error
required
Error

Error code

string
message
required
Message

Error message

string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object