Function: postRolealiases()

postRolealiases<ThrowOnError>(options?): RequestResult<PostRolealiasesResponses, PostRolealiasesErrors, ThrowOnError>

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

Creates a new role alias within the system. The PostRoleAlias endpoint allows authorized administrators to define new custom names for existing system roles by providing a PostRoleAliasDTO. This process ensures that the provided alias is validated and correctly linked to a system role, while enforcing strict authorization to prevent unauthorized modifications to the system's naming configuration. Upon successful creation, the endpoint returns the details of the new alias along with its unique location.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostRolealiasesData, ThrowOnError>

Returns

RequestResult<PostRolealiasesResponses, PostRolealiasesErrors, ThrowOnError>