Data API — Roles

10 min

role_create

sync(client: AuthenticatedClient | Client, body: CreateRoleRequest | Unset = UNSET) -> ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateRoleRequest \| Unset	UNSET

body — Request to create a user role

Returns: ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

role_delete

sync(role_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Parameter	Type	Default
role_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

role_describe

sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

role_list

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserRoleResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[UserRoleResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

role_update

sync(role_id: UUID, client: AuthenticatedClient | Client, body: CreateRoleRequest | Unset = UNSET) -> ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Parameter	Type	Default
role_id	UUID	required
client	AuthenticatedClient \| Client	required
body	CreateRoleRequest \| Unset	UNSET

body — Request to create a user role

Returns: ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.