Function: getRolealiases()

getRolealiases<ThrowOnError>(options?): RequestResult<GetRolealiasesResponses, GetRolealiasesErrors, ThrowOnError>

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

Retrieves a list of all role aliases defined in the system. The GetRoleAliases endpoint allows clients to fetch the complete collection of defined aliases, which is useful for populating dropdowns or displaying role-based information with user-friendly labels. This endpoint provides a comprehensive view of how internal roles are presented within the user interface.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetRolealiasesData, ThrowOnError>

Returns

RequestResult<GetRolealiasesResponses, GetRolealiasesErrors, ThrowOnError>