Function UsersApiFactory

Returns {
    checkUserInvitation(requestParameters, options?) => AxiosPromise<UserInvitationCheck>;
    createUser(requestParameters, options?) => AxiosPromise<User>;
    createUserInvitation(requestParameters, options?) => AxiosPromise<UserInvitation>;
    deleteUser(requestParameters, options?) => AxiosPromise<object>;
    deleteUserInvitation(requestParameters, options?) => AxiosPromise<void>;
    forgotPassword(requestParameters, options?) => AxiosPromise<void>;
    getUser(requestParameters, options?) => AxiosPromise<User>;
    getUserInvitation(requestParameters, options?) => AxiosPromise<UserInvitation>;
    impersonateUser(requestParameters, options?) => AxiosPromise<UserImpersonation>;
    listImpersonationLogs(requestParameters, options?) => AxiosPromise<any>;
    listUserInvitations(requestParameters, options?) => AxiosPromise<ListUserInvitations200Response>;
    listUsers(requestParameters, options?) => AxiosPromise<ListUsers200Response>;
    login(requestParameters, options?) => AxiosPromise<LoginDto>;
    logout(options?) => AxiosPromise<void>;
    refreshAccessToken(requestParameters, options?) => AxiosPromise<void>;
    register(requestParameters, options?) => AxiosPromise<RegisterDto>;
    resendUserInvitation(requestParameters, options?) => AxiosPromise<UserInvitation>;
    resetPassword(requestParameters, options?) => AxiosPromise<void>;
    resetUserMfaEnrollments(requestParameters, options?) => AxiosPromise<void>;
    unlockUser(requestParameters, options?) => AxiosPromise<void>;
    updateUser(requestParameters, options?) => AxiosPromise<User>;
}

• checkUserInvitation:function

  • checkUserInvitation(requestParameters, options?): AxiosPromise<UserInvitationCheck>

  • Checks for an existing User invitation.

    Summary

    Check a User Invitation

    Throws

    Parameters

    • requestParameters: UsersApiCheckUserInvitationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<UserInvitationCheck>

• createUser:function

  • createUser(requestParameters, options?): AxiosPromise<User>

  • Creates a User. Note: While the Create User endpoint has been un-deprecated for use cases requiring seamless authentication, we strongly encourage developers to utilize User Invitations for a more secure and user-friendly experience. User Invitations ensure email verification and allow users to set their own credentials, aligning with best practices for account management.

    Summary

    Create a User

    Throws

    Parameters

    • requestParameters: UsersApiCreateUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<User>

• createUserInvitation:function

  • createUserInvitation(requestParameters, options?): AxiosPromise<UserInvitation>

  • Creates a User invitation. Upon creation, an invitation email is sent to the User’s email address. Once the User registers for an Account, the invitation is deleted.

    Summary

    Create a User Invitation

    Throws

    Parameters

    • requestParameters: UsersApiCreateUserInvitationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<UserInvitation>

• deleteUser:function

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

  • Deletes a User from a specific Account. If this is the User's only Account, the User is permanently deleted. This cannot be undone.

    Summary

    Delete a User

    Throws

    Parameters

    • requestParameters: UsersApiDeleteUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<object>

• deleteUserInvitation:function

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

  • Deletes a User invitation. This cannot be undone.

    Summary

    Delete a User Invitation

    Throws

    Parameters

    • requestParameters: UsersApiDeleteUserInvitationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• forgotPassword:function

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

  • Requests a temporary link be sent to the provided email address, allowing the User to reset their password.

    Summary

    Forgot Password

    Throws

    Parameters

    • requestParameters: UsersApiForgotPasswordRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• getUser:function

  • getUser(requestParameters, options?): AxiosPromise<User>

  • Retrieves the details of an existing User.

    Summary

    Get a User

    Throws

    Parameters

    • requestParameters: UsersApiGetUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<User>

• getUserInvitation:function

  • getUserInvitation(requestParameters, options?): AxiosPromise<UserInvitation>

  • Retrieves the details of an existing User invitation.

    Summary

    Get a User Invitation

    Throws

    Parameters

    • requestParameters: UsersApiGetUserInvitationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<UserInvitation>

• impersonateUser:function

  • impersonateUser(requestParameters, options?): AxiosPromise<UserImpersonation>

  • Generate a JWT that can be used to make authenticated requests as the specified User. Note: Impersonation sessions are logged for auditing purposes and any requests made with an impersonated JWT are attributed to the impersonating user.

    Summary

    Impersonate a User

    Throws

    Parameters

    • requestParameters: UsersApiImpersonateUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<UserImpersonation>

• listImpersonationLogs:function

  • listImpersonationLogs(requestParameters, options?): AxiosPromise<any>

  • Summary

    List impersonation logs

    Throws

    Parameters

    • requestParameters: UsersApiListImpersonationLogsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<any>

• listUserInvitations:function

  • listUserInvitations(requestParameters, options?): AxiosPromise<ListUserInvitations200Response>

  • Returns a list of User invitations. The User invitations are sorted with the most recently created appearing first.

    Summary

    List all User Invitations

    Throws

    Parameters

    • requestParameters: UsersApiListUserInvitationsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListUserInvitations200Response>

• listUsers:function

  • listUsers(requestParameters, options?): AxiosPromise<ListUsers200Response>

  • Returns a list of Users. The Users are sorted with the most recently created appearing first.

    Summary

    List all Users

    Throws

    Parameters

    • requestParameters: UsersApiListUsersRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListUsers200Response>

• login:function

  • login(requestParameters, options?): AxiosPromise<LoginDto>

  • Creates a JSON Web Token.

    Summary

    Login

    Throws

    Parameters

    • requestParameters: UsersApiLoginRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<LoginDto>

• logout:function

  • logout(options?): AxiosPromise<void>

  • Invalidates a User’s refresh token.

    Summary

    Logout

    Throws

    Parameters

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• refreshAccessToken:function

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

  • Generates a new access token with a User's refresh token.

    Summary

    Refresh an Access Token

    Throws

    Parameters

    • requestParameters: UsersApiRefreshAccessTokenRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• register:function

  • register(requestParameters, options?): AxiosPromise<RegisterDto>

  • Creates a User and simultaneously creates a partner Account. Note: This endpoint should only be used in the Sandbox environment.

    Summary

    Register

    Throws

    Parameters

    • requestParameters: UsersApiRegisterRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<RegisterDto>

• resendUserInvitation:function

  • resendUserInvitation(requestParameters, options?): AxiosPromise<UserInvitation>

  • Resends an existing User invitation.

    Summary

    Resend a User Invitation

    Throws

    Parameters

    • requestParameters: UsersApiResendUserInvitationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<UserInvitation>

• resetPassword:function

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

  • Resets a User's password. Resetting the password will also invalidate the User's refresh token.

    Summary

    Reset Password

    Throws

    Parameters

    • requestParameters: UsersApiResetPasswordRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• resetUserMfaEnrollments:function

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

  • Resets a User's MFA enrollments if they have any registered. This action cannot be undone and the user will be prompted to re-enroll a MFA factor upon their next login.

    Summary

    Reset User MFA Enrollments

    Throws

    Parameters

    • requestParameters: UsersApiResetUserMfaEnrollmentsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• unlockUser:function

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

  • Unlocks a User's account that has been locked due to too many failed login attempts.

    Summary

    Unlock a User

    Throws

    Parameters

    • requestParameters: UsersApiUnlockUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• updateUser:function

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

  • Updates a User by setting the values of the provided parameters. Any parameters not provided remain unchanged.

    Summary

    Update a User

    Throws

    Parameters

    • requestParameters: UsersApiUpdateUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<User>