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<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeleteUserData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5200

`Static`deleteUserAvatarById

deleteUserAvatarById<ThrowOnError extends boolean = true>(
options: Options<DeleteUserAvatarByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserAvatarByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5402

`Static`deleteUserById

deleteUserById<ThrowOnError extends boolean = true>(
options: Options<DeleteUserByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5247

`Static`deleteUserById2FaByProviderName

deleteUserById2FaByProviderName<ThrowOnError extends boolean = true>(
options: Options<DeleteUserById2FaByProviderNameData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserById2FaByProviderNameData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5303

`Static`deleteUserByIdClientCredentialsByClientId

deleteUserByIdClientCredentialsByClientId<ThrowOnError extends boolean = true>(
    options: Options<
        DeleteUserByIdClientCredentialsByClientIdData,
        ThrowOnError,
    >,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserByIdClientCredentialsByClientIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5376

`Static`deleteUserCurrent2FaByProviderName

deleteUserCurrent2FaByProviderName<ThrowOnError extends boolean = true>(
options: Options<DeleteUserCurrent2FaByProviderNameData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserCurrent2FaByProviderNameData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5471

`Static`getFilterUser

getFilterUser<ThrowOnError extends boolean = true>(
options?: Options<GetFilterUserData, ThrowOnError>,
): RequestResult<PagedUserResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetFilterUserData, ThrowOnError>
Returns RequestResult<PagedUserResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5174

`Static`getItemUser

getItemUser<ThrowOnError extends boolean = true>(
options?: Options<GetItemUserData, ThrowOnError>,
): RequestResult<UserItemResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemUserData, ThrowOnError>
Returns RequestResult<UserItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5187

`Static`getUser

getUser<ThrowOnError extends boolean = true>(
options?: Options<GetUserData, ThrowOnError>,
): RequestResult<PagedUserResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserData, ThrowOnError>
Returns RequestResult<PagedUserResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5217

`Static`getUserById

getUserById<ThrowOnError extends boolean = true>(
options: Options<GetUserByIdData, ThrowOnError>,
): RequestResult<UserResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserByIdData, ThrowOnError>
Returns RequestResult<UserResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5260

`Static`getUserById2Fa

getUserById2Fa<ThrowOnError extends boolean = true>(
options: Options<GetUserById2FaData, ThrowOnError>,
): RequestResult<UserTwoFactorProviderModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserById2FaData, ThrowOnError>
Returns RequestResult<UserTwoFactorProviderModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5290

`Static`getUserByIdCalculateStartNodes

getUserByIdCalculateStartNodes<ThrowOnError extends boolean = true>(
    options: Options<GetUserByIdCalculateStartNodesData, ThrowOnError>,
): RequestResult<
    CalculatedUserStartNodesResponseModel,
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserByIdCalculateStartNodesData, ThrowOnError>
Returns RequestResult<CalculatedUserStartNodesResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5316

`Static`getUserByIdClientCredentials

getUserByIdClientCredentials<ThrowOnError extends boolean = true>(
options: Options<GetUserByIdClientCredentialsData, ThrowOnError>,
): RequestResult<string[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserByIdClientCredentialsData, ThrowOnError>
Returns RequestResult<string[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5346

`Static`getUserConfiguration

getUserConfiguration<ThrowOnError extends boolean = true>(
options?: Options<GetUserConfigurationData, ThrowOnError>,
): RequestResult<UserConfigurationResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserConfigurationData, ThrowOnError>
Returns RequestResult<UserConfigurationResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5432

`Static`getUserCurrent

getUserCurrent<ThrowOnError extends boolean = true>(
options?: Options<GetUserCurrentData, ThrowOnError>,
): RequestResult<CurrentUserResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrentData, ThrowOnError>
Returns RequestResult<CurrentUserResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5445

`Static`getUserCurrent2Fa

getUserCurrent2Fa<ThrowOnError extends boolean = true>(
options?: Options<GetUserCurrent2FaData, ThrowOnError>,
): RequestResult<UserTwoFactorProviderModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserCurrent2FaData, ThrowOnError>
Returns RequestResult<UserTwoFactorProviderModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5458

`Static`postUser

postUser<ThrowOnError extends boolean = true>(
options?: Options<PostUserData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5230

`Static`postUserAvatarById

postUserAvatarById<ThrowOnError extends boolean = true>(
options: Options<PostUserAvatarByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserAvatarByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5415

`Static`postUserByIdChangePassword

postUserByIdChangePassword<ThrowOnError extends boolean = true>(
options: Options<PostUserByIdChangePasswordData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserByIdChangePasswordData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5329

`Static`postUserByIdClientCredentials

postUserByIdClientCredentials<ThrowOnError extends boolean = true>(
options: Options<PostUserByIdClientCredentialsData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserByIdClientCredentialsData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5359

`Static`postUserByIdResetPassword

postUserByIdResetPassword<ThrowOnError extends boolean = true>(
options: Options<PostUserByIdResetPasswordData, ThrowOnError>,
): RequestResult<ResetPasswordUserResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserByIdResetPasswordData, ThrowOnError>
Returns RequestResult<ResetPasswordUserResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5389

`Static`postUserCurrent2FaByProviderName

postUserCurrent2FaByProviderName<ThrowOnError extends boolean = true>(
options: Options<PostUserCurrent2FaByProviderNameData, ThrowOnError>,
): RequestResult<NoopSetupTwoFactorModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserCurrent2FaByProviderNameData, ThrowOnError>
Returns RequestResult<NoopSetupTwoFactorModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5497

`Static`postUserCurrentAvatar

postUserCurrentAvatar<ThrowOnError extends boolean = true>(
options?: Options<PostUserCurrentAvatarData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserCurrentAvatarData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5514

`Static`postUserCurrentChangePassword

postUserCurrentChangePassword<ThrowOnError extends boolean = true>(
options?: Options<PostUserCurrentChangePasswordData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserCurrentChangePasswordData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5531

`Static`postUserDisable

postUserDisable<ThrowOnError extends boolean = true>(
options?: Options<PostUserDisableData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserDisableData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5613

`Static`postUserEnable

postUserEnable<ThrowOnError extends boolean = true>(
options?: Options<PostUserEnableData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserEnableData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5630

`Static`postUserInvite

postUserInvite<ThrowOnError extends boolean = true>(
options?: Options<PostUserInviteData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5647

`Static`postUserInviteCreatePassword

postUserInviteCreatePassword<ThrowOnError extends boolean = true>(
options?: Options<PostUserInviteCreatePasswordData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteCreatePasswordData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5664

`Static`postUserInviteResend

postUserInviteResend<ThrowOnError extends boolean = true>(
options?: Options<PostUserInviteResendData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteResendData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5675

`Static`postUserInviteVerify

postUserInviteVerify<ThrowOnError extends boolean = true>(
options?: Options<PostUserInviteVerifyData, ThrowOnError>,
): RequestResult<VerifyInviteUserResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserInviteVerifyData, ThrowOnError>
Returns RequestResult<VerifyInviteUserResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5692

`Static`postUserSetUserGroups

postUserSetUserGroups<ThrowOnError extends boolean = true>(
options?: Options<PostUserSetUserGroupsData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserSetUserGroupsData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5703

`Static`postUserUnlock

postUserUnlock<ThrowOnError extends boolean = true>(
options?: Options<PostUserUnlockData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserUnlockData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5720

`Static`putUserById

putUserById<ThrowOnError extends boolean = true>(
options: Options<PutUserByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutUserByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5273

Class UserService

Index

Constructors

Methods

Constructors

constructor

Returns UserService

Methods

StaticdeleteUser

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteUserAvatarById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteUserById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteUserById2FaByProviderName

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteUserByIdClientCredentialsByClientId

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteUserCurrent2FaByProviderName

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticgetFilterUser

Type Parameters

Parameters

Returns RequestResult<PagedUserResponseModel, unknown, ThrowOnError>

StaticgetItemUser

Type Parameters

Parameters

Returns RequestResult<UserItemResponseModel[], unknown, ThrowOnError>

StaticgetUser

Type Parameters

Parameters

Returns RequestResult<PagedUserResponseModel, unknown, ThrowOnError>

StaticgetUserById

Type Parameters

Parameters

Returns RequestResult<UserResponseModel, unknown, ThrowOnError>

StaticgetUserById2Fa

Type Parameters

Parameters

Returns RequestResult<UserTwoFactorProviderModel[], unknown, ThrowOnError>

StaticgetUserByIdCalculateStartNodes

Type Parameters

Parameters

Returns RequestResult<CalculatedUserStartNodesResponseModel, unknown, ThrowOnError>

StaticgetUserByIdClientCredentials

Type Parameters

Parameters

Returns RequestResult<string[], unknown, ThrowOnError>

StaticgetUserConfiguration

Type Parameters

Parameters

Returns RequestResult<UserConfigurationResponseModel, unknown, ThrowOnError>

StaticgetUserCurrent

Type Parameters

Parameters

Returns RequestResult<CurrentUserResponseModel, unknown, ThrowOnError>

StaticgetUserCurrent2Fa

Type Parameters

Parameters

Returns RequestResult<UserTwoFactorProviderModel[], unknown, ThrowOnError>

StaticgetUserCurrent2FaByProviderName

Type Parameters

Parameters

Returns RequestResult<NoopSetupTwoFactorModel, unknown, ThrowOnError>

StaticgetUserCurrentConfiguration

Type Parameters

Parameters

Returns RequestResult<CurrentUserConfigurationResponseModel, unknown, ThrowOnError>

`Static`deleteUser

`Static`deleteUserAvatarById

`Static`deleteUserById

`Static`deleteUserById2FaByProviderName

`Static`deleteUserByIdClientCredentialsByClientId

`Static`deleteUserCurrent2FaByProviderName

`Static`getFilterUser

`Static`getItemUser

`Static`getUser

`Static`getUserById

`Static`getUserById2Fa

`Static`getUserByIdCalculateStartNodes

`Static`getUserByIdClientCredentials

`Static`getUserConfiguration

`Static`getUserCurrent

`Static`getUserCurrent2Fa

`Static`getUserCurrent2FaByProviderName

`Static`getUserCurrentConfiguration

`Static`getUserCurrentLoginProviders

`Static`getUserCurrentPermissions

`Static`getUserCurrentPermissionsDocument

`Static`getUserCurrentPermissionsMedia

`Static`postUser

`Static`postUserAvatarById

`Static`postUserByIdChangePassword

`Static`postUserByIdClientCredentials

`Static`postUserByIdResetPassword

`Static`postUserCurrent2FaByProviderName

`Static`postUserCurrentAvatar

`Static`postUserCurrentChangePassword

`Static`postUserDisable

`Static`postUserEnable

`Static`postUserInvite

`Static`postUserInviteCreatePassword

`Static`postUserInviteResend

`Static`postUserInviteVerify