Skip to content
autom8y

Update Role

PUT
/auth/roles/{role_id}

Update a role.

Args: role_id: Role UUID request: Update details auth_data: Authenticated user and payload db: Database session

Returns: Updated role

Raises: 404: Role not found

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
role_id
required
Role Id
string

Request Body required

Section titled “Request Body required ”
UpdateRoleRequest

Update role request.

object
name
Any of:
string
>= 1 characters <= 100 characters
description
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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

404

Section titled “404 ”

Not Found

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