Function: putRolesById()

putRolesById<ThrowOnError>(options): RequestResult<PutRolesByIdResponses, PutRolesByIdErrors, ThrowOnError>

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

Updates the complete representation of an existing role with the provided data. The PutRole endpoint is used for comprehensive updates where a role's configuration needs to be entirely refreshed. By providing a RoleUpdateDTO, clients can ensure the role's attributes are set to a specific state. This endpoint enforces strict authorization to ensure that only designated administrators can modify the foundational role definitions of the application.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PutRolesByIdData, ThrowOnError>

Returns

RequestResult<PutRolesByIdResponses, PutRolesByIdErrors, ThrowOnError>