Function: postRoles()

postRoles<ThrowOnError>(options?): RequestResult<PostRolesResponses, PostRolesErrors, ThrowOnError>

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

Creates a new system role based on the provided configuration data. The PostRole endpoint allows authorized users to expand the system's organizational hierarchy by defining new roles through the PostRoleDTO. This process includes validating the role's properties, ensuring there are no naming conflicts, and associating the creation event with the requesting administrator. Upon successful creation, the endpoint returns the full details of the newly established role, including its system-generated identifier.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostRolesData, ThrowOnError>

Returns

RequestResult<PostRolesResponses, PostRolesErrors, ThrowOnError>