Function: getRolesById()

getRolesById<ThrowOnError>(options): RequestResult<GetRolesByIdResponses, GetRolesByIdErrors, ThrowOnError>

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

Retrieves the details of a specific role by its unique identifier. The GetRole endpoint provides a focused view of a single role entity, including its properties and associated metadata. This endpoint is useful for inspecting individual role configurations or verifying the details of a role before performing updates. If the requested role cannot be found, the endpoint provides appropriate feedback to ensure a secure and predictable API experience.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetRolesByIdData, ThrowOnError>

Returns

RequestResult<GetRolesByIdResponses, GetRolesByIdErrors, ThrowOnError>