- UserApiFactory(
configuration?: Configuration,
basePath?: string,
axios?: AxiosInstance,
): {
authenticateUserByName(
requestParameters: UserApiAuthenticateUserByNameRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<AuthenticationResult>;
authenticateWithQuickConnect(
requestParameters: UserApiAuthenticateWithQuickConnectRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<AuthenticationResult>;
createUserByName(
requestParameters: UserApiCreateUserByNameRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<UserDto>;
deleteUser(
requestParameters: UserApiDeleteUserRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
forgotPassword(
requestParameters: UserApiForgotPasswordRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<ForgotPasswordResult>;
forgotPasswordPin(
requestParameters: UserApiForgotPasswordPinRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<PinRedeemResult>;
getCurrentUser(options?: RawAxiosRequestConfig): AxiosPromise<UserDto>;
getPublicUsers(options?: RawAxiosRequestConfig): AxiosPromise<UserDto[]>;
getUserById(
requestParameters: UserApiGetUserByIdRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<UserDto>;
getUsers(
requestParameters?: UserApiGetUsersRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<UserDto[]>;
updateUser(
requestParameters: UserApiUpdateUserRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
updateUserConfiguration(
requestParameters: UserApiUpdateUserConfigurationRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
updateUserPassword(
requestParameters: UserApiUpdateUserPasswordRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
updateUserPolicy(
requestParameters: UserApiUpdateUserPolicyRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
} Parameters
Optional
configuration: ConfigurationOptional
basePath: stringOptional
axios: AxiosInstance
Returns {
authenticateUserByName(
requestParameters: UserApiAuthenticateUserByNameRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<AuthenticationResult>;
authenticateWithQuickConnect(
requestParameters: UserApiAuthenticateWithQuickConnectRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<AuthenticationResult>;
createUserByName(
requestParameters: UserApiCreateUserByNameRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<UserDto>;
deleteUser(
requestParameters: UserApiDeleteUserRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
forgotPassword(
requestParameters: UserApiForgotPasswordRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<ForgotPasswordResult>;
forgotPasswordPin(
requestParameters: UserApiForgotPasswordPinRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<PinRedeemResult>;
getCurrentUser(options?: RawAxiosRequestConfig): AxiosPromise<UserDto>;
getPublicUsers(options?: RawAxiosRequestConfig): AxiosPromise<UserDto[]>;
getUserById(
requestParameters: UserApiGetUserByIdRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<UserDto>;
getUsers(
requestParameters?: UserApiGetUsersRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<UserDto[]>;
updateUser(
requestParameters: UserApiUpdateUserRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
updateUserConfiguration(
requestParameters: UserApiUpdateUserConfigurationRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
updateUserPassword(
requestParameters: UserApiUpdateUserPasswordRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
updateUserPolicy(
requestParameters: UserApiUpdateUserPolicyRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void>;
}
authenticateUserByName:function
authenticateWithQuickConnect:function
createUserByName:function
deleteUser:function
- deleteUser(
requestParameters: UserApiDeleteUserRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void> Returns AxiosPromise<void>
forgotPassword:function
forgotPasswordPin:function
getCurrentUser:function
- getCurrentUser(options?: RawAxiosRequestConfig): AxiosPromise<UserDto>
Parameters
Optional
options: RawAxiosRequestConfig
Returns AxiosPromise<UserDto>
getPublicUsers:function
- getPublicUsers(options?: RawAxiosRequestConfig): AxiosPromise<UserDto[]>
Parameters
Optional
options: RawAxiosRequestConfig
Returns AxiosPromise<UserDto[]>
getUserById:function
getUsers:function
updateUser:function
- updateUser(
requestParameters: UserApiUpdateUserRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<void> Returns AxiosPromise<void>
updateUserConfiguration:function
updateUserPassword:function
updateUserPolicy:function
UserApi - factory interface
Export