Function: getRoles()

getRoles<ThrowOnError>(options?): RequestResult<GetRolesResponses, GetRolesErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:853

Retrieves a collection of all roles defined within the system. The GetRoles endpoint allows authorized clients to fetch the full registry of available roles, facilitating administrative oversight and providing the necessary data for role assignment interfaces. This endpoint is designed to return a comprehensive list of role entities, ensuring that clients have access to the current organizational structure and permission tiers established within the application.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetRolesData, ThrowOnError>

Returns

RequestResult<GetRolesResponses, GetRolesErrors, ThrowOnError>