Skip to content
autom8y

List Roles

GET
/auth/roles

List all roles in a business.

Requires admin:roles permission.

Args: business_id: Business/tenant UUID auth_data: Authenticated user and payload db: Database session

Returns: List of roles with their permissions

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
business_id
required
Business Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Roles Auth Roles Get
Array<object>
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

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