Function UserApiFactory

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

  • authenticateUserByName(requestParameters, options?): AxiosPromise<AuthenticationResult>

  • Parameters

    • requestParameters: UserApiAuthenticateUserByNameRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AuthenticationResult>

    Summary

    Authenticates a user by name.

    Throws

• authenticateWithQuickConnect:function

  • authenticateWithQuickConnect(requestParameters, options?): AxiosPromise<AuthenticationResult>

  • Parameters

    • requestParameters: UserApiAuthenticateWithQuickConnectRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AuthenticationResult>

    Summary

    Authenticates a user with quick connect.

    Throws

• createUserByName:function

  • createUserByName(requestParameters, options?): AxiosPromise<UserDto>

  • Parameters

    • requestParameters: UserApiCreateUserByNameRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserDto>

    Summary

    Creates a user.

    Throws

• deleteUser:function

  • deleteUser(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: UserApiDeleteUserRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Deletes a user.

    Throws

• forgotPassword:function

  • forgotPassword(requestParameters, options?): AxiosPromise<ForgotPasswordResult>

  • Parameters

    • requestParameters: UserApiForgotPasswordRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ForgotPasswordResult>

    Summary

    Initiates the forgot password process for a local user.

    Throws

• forgotPasswordPin:function

  • forgotPasswordPin(requestParameters, options?): AxiosPromise<PinRedeemResult>

  • Parameters

    • requestParameters: UserApiForgotPasswordPinRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PinRedeemResult>

    Summary

    Redeems a forgot password pin.

    Throws

• getCurrentUser:function

  • getCurrentUser(options?): AxiosPromise<UserDto>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserDto>

    Summary

    Gets the user based on auth token.

    Throws

• getPublicUsers:function

  • getPublicUsers(options?): AxiosPromise<UserDto[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserDto[]>

    Summary

    Gets a list of publicly visible users for display on a login screen.

    Throws

• getUserById:function

  • getUserById(requestParameters, options?): AxiosPromise<UserDto>

  • Parameters

    • requestParameters: UserApiGetUserByIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserDto>

    Summary

    Gets a user by Id.

    Throws

• getUsers:function

  • getUsers(requestParameters?, options?): AxiosPromise<UserDto[]>

  • Parameters

    • requestParameters: UserApiGetUsersRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserDto[]>

    Summary

    Gets a list of users.

    Throws

• updateUser:function

  • updateUser(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: UserApiUpdateUserRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates a user.

    Throws

• updateUserConfiguration:function

  • updateUserConfiguration(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: UserApiUpdateUserConfigurationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates a user configuration.

    Throws

• updateUserPassword:function

  • updateUserPassword(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: UserApiUpdateUserPasswordRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates a user's password.

    Throws

• updateUserPolicy:function

  • updateUserPolicy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: UserApiUpdateUserPolicyRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates a user policy.

    Throws