Class UserService

Index

Constructors

Methods

deleteUser deleteUserAvatarById deleteUserById deleteUserById2FaByProviderName deleteUserByIdClientCredentialsByClientId deleteUserCurrent2FaByProviderName getFilterUser getItemUser getUser getUserById getUserById2Fa getUserByIdCalculateStartNodes getUserByIdClientCredentials getUserConfiguration getUserCurrent getUserCurrent2Fa getUserCurrent2FaByProviderName getUserCurrentConfiguration getUserCurrentLoginProviders getUserCurrentPermissions getUserCurrentPermissionsDocument getUserCurrentPermissionsMedia postUser postUserAvatarById postUserByIdChangePassword postUserByIdClientCredentials postUserByIdResetPassword postUserCurrent2FaByProviderName postUserCurrentAvatar postUserCurrentChangePassword postUserDisable postUserEnable postUserInvite postUserInviteCreatePassword postUserInviteResend postUserInviteVerify postUserSetUserGroups postUserUnlock putUserById

Constructors

constructor

new UserService(): UserService
Returns UserService

Methods

`Static`deleteUser

deleteUser<ThrowOnError extends boolean = true>(
    options?: Options<DeleteUserData, ThrowOnError>,
): RequestResult<
    DeleteUserResponses,
    DeleteUserErrors,
    ThrowOnError,
    "fields",
>
Deletes multiple users. Deletes multiple users identified by the provided Ids. This operation cannot be undone.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeleteUserData, ThrowOnError>
Returns RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7347

`Static`deleteUserAvatarById

deleteUserAvatarById<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserAvatarByIdData, ThrowOnError>,
): RequestResult<
    DeleteUserAvatarByIdResponses,
    DeleteUserAvatarByIdErrors,
    ThrowOnError,
    "fields",
>
Clears a user's avatar. Removes the avatar image for the user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserAvatarByIdData, ThrowOnError>
Returns RequestResult<
    DeleteUserAvatarByIdResponses,
    DeleteUserAvatarByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7605

`Static`deleteUserById

deleteUserById<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserByIdData, ThrowOnError>,
): RequestResult<
    DeleteUserByIdResponses,
    DeleteUserByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a user. Deletes a user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserByIdData, ThrowOnError>
Returns RequestResult<
    DeleteUserByIdResponses,
    DeleteUserByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7406

`Static`deleteUserById2FaByProviderName

deleteUserById2FaByProviderName<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserById2FaByProviderNameData, ThrowOnError>,
): RequestResult<
    DeleteUserById2FaByProviderNameResponses,
    DeleteUserById2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
Disables two-factor authentication for a user. Disables the specified two-factor authentication provider for a user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserById2FaByProviderNameData, ThrowOnError>
Returns RequestResult<
    DeleteUserById2FaByProviderNameResponses,
    DeleteUserById2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7478

`Static`deleteUserByIdClientCredentialsByClientId

deleteUserByIdClientCredentialsByClientId<ThrowOnError extends boolean = true>(
    options: Options<
        DeleteUserByIdClientCredentialsByClientIdData,
        ThrowOnError,
    >,
): RequestResult<
    DeleteUserByIdClientCredentialsByClientIdResponses,
    DeleteUserByIdClientCredentialsByClientIdErrors,
    ThrowOnError,
    "fields",
>
Deletes client credentials for a user. Deletes client credentials identified by the provided client Id for a user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserByIdClientCredentialsByClientIdData, ThrowOnError>
Returns RequestResult<
    DeleteUserByIdClientCredentialsByClientIdResponses,
    DeleteUserByIdClientCredentialsByClientIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7571

`Static`deleteUserCurrent2FaByProviderName

deleteUserCurrent2FaByProviderName<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserCurrent2FaByProviderNameData, ThrowOnError>,
): RequestResult<
    DeleteUserCurrent2FaByProviderNameResponses,
    DeleteUserCurrent2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
Disables two-factor authentication for the current user. Disables the specified two-factor authentication provider for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserCurrent2FaByProviderNameData, ThrowOnError>
Returns RequestResult<
    DeleteUserCurrent2FaByProviderNameResponses,
    DeleteUserCurrent2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7694

`Static`getFilterUser

getFilterUser<ThrowOnError extends boolean = true>(
    options?: Options<GetFilterUserData, ThrowOnError>,
): RequestResult<
    GetFilterUserResponses,
    GetFilterUserErrors,
    ThrowOnError,
    "fields",
>
Gets a filtered collection of users. Filters users based on the provided criteria with support for pagination.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetFilterUserData, ThrowOnError>
Returns RequestResult<
    GetFilterUserResponses,
    GetFilterUserErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7313

`Static`getItemUser

getItemUser<ThrowOnError extends boolean = true>(
    options?: Options<GetItemUserData, ThrowOnError>,
): RequestResult<
    GetItemUserResponses,
    GetItemUserErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of user items. Gets a collection of user items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemUserData, ThrowOnError>
Returns RequestResult<GetItemUserResponses, GetItemUserErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7330

`Static`getUser

getUser<ThrowOnError extends boolean = true>(
options?: Options<GetUserData, ThrowOnError>,
): RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">
Gets a paginated collection of users. Gets a paginated collection of all users.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserData, ThrowOnError>
Returns RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7368

`Static`getUserById

getUserById<ThrowOnError extends boolean = true>(
    options: Options<GetUserByIdData, ThrowOnError>,
): RequestResult<
    GetUserByIdResponses,
    GetUserByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a user. Gets a user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserByIdData, ThrowOnError>
Returns RequestResult<GetUserByIdResponses, GetUserByIdErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7423

`Static`getUserById2Fa

getUserById2Fa<ThrowOnError extends boolean = true>(
    options: Options<GetUserById2FaData, ThrowOnError>,
): RequestResult<
    GetUserById2FaResponses,
    GetUserById2FaErrors,
    ThrowOnError,
    "fields",
>
Lists two-factor providers for a user. Gets a list of available two-factor authentication providers for the specified user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserById2FaData, ThrowOnError>
Returns RequestResult<
    GetUserById2FaResponses,
    GetUserById2FaErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7461

`Static`getUserByIdCalculateStartNodes

getUserByIdCalculateStartNodes<ThrowOnError extends boolean = true>(
    options: Options<GetUserByIdCalculateStartNodesData, ThrowOnError>,
): RequestResult<
    GetUserByIdCalculateStartNodesResponses,
    GetUserByIdCalculateStartNodesErrors,
    ThrowOnError,
    "fields",
>
Calculates start nodes for users. Calculates the start nodes for the users identified by the provided Ids based on their permissions.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserByIdCalculateStartNodesData, ThrowOnError>
Returns RequestResult<
    GetUserByIdCalculateStartNodesResponses,
    GetUserByIdCalculateStartNodesErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7495

`Static`getUserByIdClientCredentials

getUserByIdClientCredentials<ThrowOnError extends boolean = true>(
    options: Options<GetUserByIdClientCredentialsData, ThrowOnError>,
): RequestResult<
    GetUserByIdClientCredentialsResponses,
    GetUserByIdClientCredentialsErrors,
    ThrowOnError,
    "fields",
>
Gets all client credentials for a user. Gets a collection of OAuth client credentials for the user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserByIdClientCredentialsData, ThrowOnError>
Returns RequestResult<
    GetUserByIdClientCredentialsResponses,
    GetUserByIdClientCredentialsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7533

`Static`getUserConfiguration

getUserConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetUserConfigurationData, ThrowOnError>,
): RequestResult<
    GetUserConfigurationResponses,
    GetUserConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the user configuration. Gets the configuration settings for users.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserConfigurationData, ThrowOnError>
Returns RequestResult<
    GetUserConfigurationResponses,
    GetUserConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7643

`Static`getUserCurrent

getUserCurrent<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrentData, ThrowOnError>,
): RequestResult<
    GetUserCurrentResponses,
    GetUserCurrentErrors,
    ThrowOnError,
    "fields",
>
Gets the current user. Gets the currently authenticated back office user's information and permissions.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentData, ThrowOnError>
Returns RequestResult<
    GetUserCurrentResponses,
    GetUserCurrentErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7660

`Static`getUserCurrent2Fa

getUserCurrent2Fa<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrent2FaData, ThrowOnError>,
): RequestResult<
    GetUserCurrent2FaResponses,
    GetUserCurrent2FaErrors,
    ThrowOnError,
    "fields",
>
Lists two-factor providers for the current user. Gets a list of available two-factor authentication providers for the current user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrent2FaData, ThrowOnError>
Returns RequestResult<
    GetUserCurrent2FaResponses,
    GetUserCurrent2FaErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7677

`Static`getUserCurrent2FaByProviderName

getUserCurrent2FaByProviderName<ThrowOnError extends boolean = true>(
    options: Options<GetUserCurrent2FaByProviderNameData, ThrowOnError>,
): RequestResult<
    GetUserCurrent2FaByProviderNameResponses,
    GetUserCurrent2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
Gets two-factor setup information. Gets the setup information for configuring a two-factor authentication provider.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserCurrent2FaByProviderNameData, ThrowOnError>
Returns RequestResult<
    GetUserCurrent2FaByProviderNameResponses,
    GetUserCurrent2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7711

`Static`getUserCurrentConfiguration

getUserCurrentConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrentConfigurationData, ThrowOnError>,
): RequestResult<
    GetUserCurrentConfigurationResponses,
    GetUserCurrentConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the current user's configuration. Gets the configuration settings for the current user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentConfigurationData, ThrowOnError>
Returns RequestResult<
    GetUserCurrentConfigurationResponses,
    GetUserCurrentConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7791

`Static`getUserCurrentLoginProviders

getUserCurrentLoginProviders<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrentLoginProvidersData, ThrowOnError>,
): RequestResult<
    GetUserCurrentLoginProvidersResponses,
    GetUserCurrentLoginProvidersErrors,
    ThrowOnError,
    "fields",
>
Lists external login providers. Gets a list of configured external login providers for authentication.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentLoginProvidersData, ThrowOnError>
Returns RequestResult<
    GetUserCurrentLoginProvidersResponses,
    GetUserCurrentLoginProvidersErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7808

`Static`getUserCurrentPermissions

getUserCurrentPermissions<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrentPermissionsData, ThrowOnError>,
): RequestResult<
    GetUserCurrentPermissionsResponses,
    GetUserCurrentPermissionsErrors,
    ThrowOnError,
    "fields",
>
Gets permissions for the current user. Gets the permissions for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentPermissionsData, ThrowOnError>
Returns RequestResult<
    GetUserCurrentPermissionsResponses,
    GetUserCurrentPermissionsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7825

`Static`getUserCurrentPermissionsDocument

getUserCurrentPermissionsDocument<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrentPermissionsDocumentData, ThrowOnError>,
): RequestResult<
    GetUserCurrentPermissionsDocumentResponses,
    GetUserCurrentPermissionsDocumentErrors,
    ThrowOnError,
    "fields",
>
Gets document permissions for the current user. Gets the document permissions for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentPermissionsDocumentData, ThrowOnError>
Returns RequestResult<
    GetUserCurrentPermissionsDocumentResponses,
    GetUserCurrentPermissionsDocumentErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7842

`Static`getUserCurrentPermissionsMedia

getUserCurrentPermissionsMedia<ThrowOnError extends boolean = true>(
    options?: Options<GetUserCurrentPermissionsMediaData, ThrowOnError>,
): RequestResult<
    GetUserCurrentPermissionsMediaResponses,
    GetUserCurrentPermissionsMediaErrors,
    ThrowOnError,
    "fields",
>
Gets media permissions for the current user. Gets the media permissions for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentPermissionsMediaData, ThrowOnError>
Returns RequestResult<
    GetUserCurrentPermissionsMediaResponses,
    GetUserCurrentPermissionsMediaErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7859

`Static`postUser

postUser<ThrowOnError extends boolean = true>(
options?: Options<PostUserData, ThrowOnError>,
): RequestResult<PostUserResponses, PostUserErrors, ThrowOnError, "fields">
Creates a new user. Creates a new user with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserData, ThrowOnError>
Returns RequestResult<PostUserResponses, PostUserErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7385

`Static`postUserAvatarById

postUserAvatarById<ThrowOnError extends boolean = true>(
    options: Options<PostUserAvatarByIdData, ThrowOnError>,
): RequestResult<
    PostUserAvatarByIdResponses,
    PostUserAvatarByIdErrors,
    ThrowOnError,
    "fields",
>
Sets a user's avatar. Sets or updates the avatar image for the user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserAvatarByIdData, ThrowOnError>
Returns RequestResult<
    PostUserAvatarByIdResponses,
    PostUserAvatarByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7622

`Static`postUserByIdChangePassword

postUserByIdChangePassword<ThrowOnError extends boolean = true>(
    options: Options<PostUserByIdChangePasswordData, ThrowOnError>,
): RequestResult<
    PostUserByIdChangePasswordResponses,
    PostUserByIdChangePasswordErrors,
    ThrowOnError,
    "fields",
>
Changes a user's password. Changes the password for the user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserByIdChangePasswordData, ThrowOnError>
Returns RequestResult<
    PostUserByIdChangePasswordResponses,
    PostUserByIdChangePasswordErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7512

`Static`postUserByIdClientCredentials

postUserByIdClientCredentials<ThrowOnError extends boolean = true>(
    options: Options<PostUserByIdClientCredentialsData, ThrowOnError>,
): RequestResult<
    PostUserByIdClientCredentialsResponses,
    PostUserByIdClientCredentialsErrors,
    ThrowOnError,
    "fields",
>
Creates client credentials for a user. Creates OAuth client credentials for the user identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserByIdClientCredentialsData, ThrowOnError>
Returns RequestResult<
    PostUserByIdClientCredentialsResponses,
    PostUserByIdClientCredentialsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7550

`Static`postUserByIdResetPassword

postUserByIdResetPassword<ThrowOnError extends boolean = true>(
    options: Options<PostUserByIdResetPasswordData, ThrowOnError>,
): RequestResult<
    PostUserByIdResetPasswordResponses,
    PostUserByIdResetPasswordErrors,
    ThrowOnError,
    "fields",
>
Resets a user's password. Resets the password for the user using the provided reset token.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserByIdResetPasswordData, ThrowOnError>
Returns RequestResult<
    PostUserByIdResetPasswordResponses,
    PostUserByIdResetPasswordErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7588

`Static`postUserCurrent2FaByProviderName

postUserCurrent2FaByProviderName<ThrowOnError extends boolean = true>(
    options: Options<PostUserCurrent2FaByProviderNameData, ThrowOnError>,
): RequestResult<
    PostUserCurrent2FaByProviderNameResponses,
    PostUserCurrent2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
Enables two-factor authentication for the current user. Enables the specified two-factor authentication provider for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserCurrent2FaByProviderNameData, ThrowOnError>
Returns RequestResult<
    PostUserCurrent2FaByProviderNameResponses,
    PostUserCurrent2FaByProviderNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7728

`Static`postUserCurrentAvatar

postUserCurrentAvatar<ThrowOnError extends boolean = true>(
    options?: Options<PostUserCurrentAvatarData, ThrowOnError>,
): RequestResult<
    PostUserCurrentAvatarResponses,
    PostUserCurrentAvatarErrors,
    ThrowOnError,
    "fields",
>
Sets the current user's avatar. Sets or updates the avatar image for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserCurrentAvatarData, ThrowOnError>
Returns RequestResult<
    PostUserCurrentAvatarResponses,
    PostUserCurrentAvatarErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7749

`Static`postUserCurrentChangePassword

postUserCurrentChangePassword<ThrowOnError extends boolean = true>(
    options?: Options<PostUserCurrentChangePasswordData, ThrowOnError>,
): RequestResult<
    PostUserCurrentChangePasswordResponses,
    PostUserCurrentChangePasswordErrors,
    ThrowOnError,
    "fields",
>
Changes the current user's password. Changes the password for the currently authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserCurrentChangePasswordData, ThrowOnError>
Returns RequestResult<
    PostUserCurrentChangePasswordResponses,
    PostUserCurrentChangePasswordErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7770

`Static`postUserDisable

postUserDisable<ThrowOnError extends boolean = true>(
    options?: Options<PostUserDisableData, ThrowOnError>,
): RequestResult<
    PostUserDisableResponses,
    PostUserDisableErrors,
    ThrowOnError,
    "fields",
>
Disables users. Disables the user accounts identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserDisableData, ThrowOnError>
Returns RequestResult<
    PostUserDisableResponses,
    PostUserDisableErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7876

`Static`postUserEnable

postUserEnable<ThrowOnError extends boolean = true>(
    options?: Options<PostUserEnableData, ThrowOnError>,
): RequestResult<
    PostUserEnableResponses,
    PostUserEnableErrors,
    ThrowOnError,
    "fields",
>
Enables users. Enables the user accounts identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserEnableData, ThrowOnError>
Returns RequestResult<
    PostUserEnableResponses,
    PostUserEnableErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7897

`Static`postUserInvite

postUserInvite<ThrowOnError extends boolean = true>(
    options?: Options<PostUserInviteData, ThrowOnError>,
): RequestResult<
    PostUserInviteResponses,
    PostUserInviteErrors,
    ThrowOnError,
    "fields",
>
Invites new users. Sends invitation emails to create new user accounts with the specified details.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteData, ThrowOnError>
Returns RequestResult<
    PostUserInviteResponses,
    PostUserInviteErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7918

`Static`postUserInviteCreatePassword

postUserInviteCreatePassword<ThrowOnError extends boolean = true>(
    options?: Options<PostUserInviteCreatePasswordData, ThrowOnError>,
): RequestResult<
    PostUserInviteCreatePasswordResponses,
    PostUserInviteCreatePasswordErrors,
    ThrowOnError,
    "fields",
>
Creates an initial password for a user. Creates an initial password for a newly invited user using the provided token.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteCreatePasswordData, ThrowOnError>
Returns RequestResult<
    PostUserInviteCreatePasswordResponses,
    PostUserInviteCreatePasswordErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7939

`Static`postUserInviteResend

postUserInviteResend<ThrowOnError extends boolean = true>(
    options?: Options<PostUserInviteResendData, ThrowOnError>,
): RequestResult<
    PostUserInviteResendResponses,
    PostUserInviteResendErrors,
    ThrowOnError,
    "fields",
>
Resends a user invitation. Resends the invitation email for the users identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteResendData, ThrowOnError>
Returns RequestResult<
    PostUserInviteResendResponses,
    PostUserInviteResendErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7954

`Static`postUserInviteVerify

postUserInviteVerify<ThrowOnError extends boolean = true>(
    options?: Options<PostUserInviteVerifyData, ThrowOnError>,
): RequestResult<
    PostUserInviteVerifyResponses,
    PostUserInviteVerifyErrors,
    ThrowOnError,
    "fields",
>
Verifies a user invitation. Verifies that the invitation token is valid for creating a new user account.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteVerifyData, ThrowOnError>
Returns RequestResult<
    PostUserInviteVerifyResponses,
    PostUserInviteVerifyErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7975

`Static`postUserSetUserGroups

postUserSetUserGroups<ThrowOnError extends boolean = true>(
    options?: Options<PostUserSetUserGroupsData, ThrowOnError>,
): RequestResult<
    PostUserSetUserGroupsResponses,
    PostUserSetUserGroupsErrors,
    ThrowOnError,
    "fields",
>
Updates user group assignments. Updates the user group assignments for the specified users.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserSetUserGroupsData, ThrowOnError>
Returns RequestResult<
    PostUserSetUserGroupsResponses,
    PostUserSetUserGroupsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7990

`Static`postUserUnlock

postUserUnlock<ThrowOnError extends boolean = true>(
    options?: Options<PostUserUnlockData, ThrowOnError>,
): RequestResult<
    PostUserUnlockResponses,
    PostUserUnlockErrors,
    ThrowOnError,
    "fields",
>
Unlocks users. Unlocks the user accounts identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserUnlockData, ThrowOnError>
Returns RequestResult<
    PostUserUnlockResponses,
    PostUserUnlockErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8011

`Static`putUserById

putUserById<ThrowOnError extends boolean = true>(
    options: Options<PutUserByIdData, ThrowOnError>,
): RequestResult<
    PutUserByIdResponses,
    PutUserByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a user. Updates a user identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutUserByIdData, ThrowOnError>
Returns RequestResult<PutUserByIdResponses, PutUserByIdErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7440

Class UserService

Index

Constructors

Methods

Constructors

constructor

Returns UserService

Methods

StaticdeleteUser

Type Parameters

Parameters

Returns RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">

StaticdeleteUserAvatarById

Type Parameters

Parameters

Returns RequestResult< DeleteUserAvatarByIdResponses, DeleteUserAvatarByIdErrors, ThrowOnError, "fields",>

StaticdeleteUserById

Type Parameters

Parameters

Returns RequestResult< DeleteUserByIdResponses, DeleteUserByIdErrors, ThrowOnError, "fields",>

StaticdeleteUserById2FaByProviderName

Type Parameters

Parameters

Returns RequestResult< DeleteUserById2FaByProviderNameResponses, DeleteUserById2FaByProviderNameErrors, ThrowOnError, "fields",>

StaticdeleteUserByIdClientCredentialsByClientId

Type Parameters

Parameters

Returns RequestResult< DeleteUserByIdClientCredentialsByClientIdResponses, DeleteUserByIdClientCredentialsByClientIdErrors, ThrowOnError, "fields",>

StaticdeleteUserCurrent2FaByProviderName

Type Parameters

Parameters

Returns RequestResult< DeleteUserCurrent2FaByProviderNameResponses, DeleteUserCurrent2FaByProviderNameErrors, ThrowOnError, "fields",>

StaticgetFilterUser

Type Parameters

Parameters

Returns RequestResult< GetFilterUserResponses, GetFilterUserErrors, ThrowOnError, "fields",>

StaticgetItemUser

Type Parameters

Parameters

Returns RequestResult<GetItemUserResponses, GetItemUserErrors, ThrowOnError, "fields">

StaticgetUser

Type Parameters

Parameters

Returns RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">

StaticgetUserById

Type Parameters

Parameters

Returns RequestResult<GetUserByIdResponses, GetUserByIdErrors, ThrowOnError, "fields">

StaticgetUserById2Fa

Type Parameters

Parameters

Returns RequestResult< GetUserById2FaResponses, GetUserById2FaErrors, ThrowOnError, "fields",>

StaticgetUserByIdCalculateStartNodes

Type Parameters

Parameters

Returns RequestResult< GetUserByIdCalculateStartNodesResponses, GetUserByIdCalculateStartNodesErrors, ThrowOnError, "fields",>

StaticgetUserByIdClientCredentials

Type Parameters

Parameters

Returns RequestResult< GetUserByIdClientCredentialsResponses, GetUserByIdClientCredentialsErrors, ThrowOnError, "fields",>

StaticgetUserConfiguration

Type Parameters

Parameters

Returns RequestResult< GetUserConfigurationResponses, GetUserConfigurationErrors, ThrowOnError, "fields",>

StaticgetUserCurrent

Type Parameters

Parameters

Returns RequestResult< GetUserCurrentResponses, GetUserCurrentErrors, ThrowOnError, "fields",>

StaticgetUserCurrent2Fa

Type Parameters

Parameters

Returns RequestResult< GetUserCurrent2FaResponses, GetUserCurrent2FaErrors, ThrowOnError, "fields",>

StaticgetUserCurrent2FaByProviderName

Type Parameters

Parameters

Returns RequestResult< GetUserCurrent2FaByProviderNameResponses, GetUserCurrent2FaByProviderNameErrors, ThrowOnError, "fields",>

StaticgetUserCurrentConfiguration

Type Parameters

Parameters

Returns RequestResult< GetUserCurrentConfigurationResponses, GetUserCurrentConfigurationErrors, ThrowOnError, "fields",>

`Static`deleteUser

`Static`deleteUserAvatarById

Returns RequestResult<
DeleteUserAvatarByIdResponses,
DeleteUserAvatarByIdErrors,
ThrowOnError,
"fields",
>

`Static`deleteUserById

Returns RequestResult<
DeleteUserByIdResponses,
DeleteUserByIdErrors,
ThrowOnError,
"fields",
>

`Static`deleteUserById2FaByProviderName

Returns RequestResult<
DeleteUserById2FaByProviderNameResponses,
DeleteUserById2FaByProviderNameErrors,
ThrowOnError,
"fields",
>

`Static`deleteUserByIdClientCredentialsByClientId

Returns RequestResult<
DeleteUserByIdClientCredentialsByClientIdResponses,
DeleteUserByIdClientCredentialsByClientIdErrors,
ThrowOnError,
"fields",
>

`Static`deleteUserCurrent2FaByProviderName

Returns RequestResult<
DeleteUserCurrent2FaByProviderNameResponses,
DeleteUserCurrent2FaByProviderNameErrors,
ThrowOnError,
"fields",
>

`Static`getFilterUser

Returns RequestResult<
GetFilterUserResponses,
GetFilterUserErrors,
ThrowOnError,
"fields",
>

`Static`getItemUser

`Static`getUser

`Static`getUserById

`Static`getUserById2Fa

Returns RequestResult<
GetUserById2FaResponses,
GetUserById2FaErrors,
ThrowOnError,
"fields",
>

`Static`getUserByIdCalculateStartNodes

Returns RequestResult<
GetUserByIdCalculateStartNodesResponses,
GetUserByIdCalculateStartNodesErrors,
ThrowOnError,
"fields",
>

`Static`getUserByIdClientCredentials

Returns RequestResult<
GetUserByIdClientCredentialsResponses,
GetUserByIdClientCredentialsErrors,
ThrowOnError,
"fields",
>

`Static`getUserConfiguration

Returns RequestResult<
GetUserConfigurationResponses,
GetUserConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrent

Returns RequestResult<
GetUserCurrentResponses,
GetUserCurrentErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrent2Fa

Returns RequestResult<
GetUserCurrent2FaResponses,
GetUserCurrent2FaErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrent2FaByProviderName

Returns RequestResult<
GetUserCurrent2FaByProviderNameResponses,
GetUserCurrent2FaByProviderNameErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrentConfiguration

Returns RequestResult<
GetUserCurrentConfigurationResponses,
GetUserCurrentConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrentLoginProviders

Returns RequestResult<
GetUserCurrentLoginProvidersResponses,
GetUserCurrentLoginProvidersErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrentPermissions

Returns RequestResult<
GetUserCurrentPermissionsResponses,
GetUserCurrentPermissionsErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrentPermissionsDocument

Returns RequestResult<
GetUserCurrentPermissionsDocumentResponses,
GetUserCurrentPermissionsDocumentErrors,
ThrowOnError,
"fields",
>

`Static`getUserCurrentPermissionsMedia

Returns RequestResult<
GetUserCurrentPermissionsMediaResponses,
GetUserCurrentPermissionsMediaErrors,
ThrowOnError,
"fields",
>

`Static`postUser

`Static`postUserAvatarById

Returns RequestResult<
PostUserAvatarByIdResponses,
PostUserAvatarByIdErrors,
ThrowOnError,
"fields",
>

`Static`postUserByIdChangePassword

Returns RequestResult<
PostUserByIdChangePasswordResponses,
PostUserByIdChangePasswordErrors,
ThrowOnError,
"fields",
>

`Static`postUserByIdClientCredentials

Returns RequestResult<
PostUserByIdClientCredentialsResponses,
PostUserByIdClientCredentialsErrors,
ThrowOnError,
"fields",
>

`Static`postUserByIdResetPassword

Returns RequestResult<
PostUserByIdResetPasswordResponses,
PostUserByIdResetPasswordErrors,
ThrowOnError,
"fields",
>

`Static`postUserCurrent2FaByProviderName

Returns RequestResult<
PostUserCurrent2FaByProviderNameResponses,
PostUserCurrent2FaByProviderNameErrors,
ThrowOnError,
"fields",
>

`Static`postUserCurrentAvatar

Returns RequestResult<
PostUserCurrentAvatarResponses,
PostUserCurrentAvatarErrors,
ThrowOnError,
"fields",
>

`Static`postUserCurrentChangePassword

Returns RequestResult<
PostUserCurrentChangePasswordResponses,
PostUserCurrentChangePasswordErrors,
ThrowOnError,
"fields",
>

`Static`postUserDisable

Returns RequestResult<
PostUserDisableResponses,
PostUserDisableErrors,
ThrowOnError,
"fields",
>

`Static`postUserEnable

Returns RequestResult<
PostUserEnableResponses,
PostUserEnableErrors,
ThrowOnError,
"fields",
>

`Static`postUserInvite

Returns RequestResult<
PostUserInviteResponses,
PostUserInviteErrors,
ThrowOnError,
"fields",
>

`Static`postUserInviteCreatePassword

Returns RequestResult<
PostUserInviteCreatePasswordResponses,
PostUserInviteCreatePasswordErrors,
ThrowOnError,
"fields",
>

`Static`postUserInviteResend

Returns RequestResult<
PostUserInviteResendResponses,
PostUserInviteResendErrors,
ThrowOnError,
"fields",
>

`Static`postUserInviteVerify