Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the "actioner". Both user ids are required in the request object.

@param request [Hash] The action request that includes all of the information about the action being taken including the id of the action, any options and the duration (if applicable). @return [FusionAuth::ClientResponse] The ClientResponse object.

Adds a user to an existing family. The family id must be specified.

@param family_id [String] The id of the family. @param request [Hash] The request object that contains all of the information used to determine which user to add to the family. @return [FusionAuth::ClientResponse] The ClientResponse object.

Cancels the user action.

@param action_id [String] The action id of the action to cancel. @param request [Hash] The action request that contains the information about the cancellation. @return [FusionAuth::ClientResponse] The ClientResponse object.

Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user and they clicked on a link to reset their password.

@param change_password_id [String] The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated. @param request [Hash] The change password request that contains all of the information used to change the password. @return [FusionAuth::ClientResponse] The ClientResponse object.

Changes a user's password using their identity (login id and password). Using a loginId instead of the changePasswordId bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword method.

@param request [Hash] The change password request that contains all of the information used to change the password. @return [FusionAuth::ClientResponse] The ClientResponse object.

Adds a comment to the user's account.

@param request [Hash] The request object that contains all of the information used to create the user comment. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.

@param application_id [String] (Optional) The Id to use for the application. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the application. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a new role for an application. You must specify the id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.

@param application_id [String] The Id of the application to create the role on. @param role_id [String] (Optional) The Id of the role. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the application role. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.

@param request [Hash] The request object that contains all of the information used to create the audit log entry. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.

@param connector_id [String] (Optional) The Id for the connector. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the connector. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.

@param consent_id [String] (Optional) The Id for the consent. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the consent. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.

@param email_template_id [String] (Optional) The Id for the template. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the email template. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a family with the user id in the request as the owner and sole member of the family. You can optionally specify an id for the family, if not provided one will be generated.

@param family_id [String] (Optional) The id for the family. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the family. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.

@param form_id [String] (Optional) The Id for the form. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the form. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.

@param field_id [String] (Optional) The Id for the form field. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the form field. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.

@param group_id [String] (Optional) The Id for the group. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the group. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a member in a group.

@param request [Hash] The request object that contains all of the information used to create the group member(s). @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.

@param identity_provider_id [String] (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the identity provider. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.

@param lambda_id [String] (Optional) The Id for the lambda. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the lambda. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.

@param tenant_id [String] (Optional) The Id for the tenant. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the tenant. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.

@param theme_id [String] (Optional) The Id for the theme. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the theme. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.

@param user_id [String] (Optional) The Id for the user. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user.

@param user_action_id [String] (Optional) The Id for the user action. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the user action. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action reason can be used.

@param user_action_reason_id [String] (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the user action reason. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a single User consent.

@param user_consent_id [String] (Optional) The Id for the User consent. If not provided a secure random UUID will be generated. @param request [Hash] The request that contains the user consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.

@param webhook_id [String] (Optional) The Id for the webhook. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the webhook. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deactivates the application with the given Id.

@param application_id [String] The Id of the application to deactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deactivates the user with the given Id.

@param user_id [String] The Id of the user to deactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deactivates the user action with the given Id.

@param user_action_id [String] The Id of the user action to deactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deactivates the users with the given ids.

@param user_ids [Array] The ids of the users to deactivate. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to deactivate_users_by_ids, use that method instead.

Deactivates the users with the given ids.

@param user_ids [Array] The ids of the users to deactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will delete the application, any registrations for that application, metrics and reports for the application, all the roles for the application, and any other data associated with the application. This operation could take a very long time, depending on the amount of data in your database.

@param application_id [String] The Id of the application to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given role from all users that had it.

@param application_id [String] The Id of the application to deactivate. @param role_id [String] The Id of the role to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the connector for the given Id.

@param connector_id [String] The Id of the connector to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the consent for the given Id.

@param consent_id [String] The Id of the consent to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the email template for the given Id.

@param email_template_id [String] The Id of the email template to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the form for the given Id.

@param form_id [String] The Id of the form to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the form field for the given Id.

@param field_id [String] The Id of the form field to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the group for the given Id.

@param group_id [String] The Id of the group to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Removes users as members of a group.

@param request [Hash] The member request that contains all of the information used to remove members to the group. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the identity provider for the given Id.

@param identity_provider_id [String] The Id of the identity provider to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the key for the given Id.

@param key_id [String] The Id of the key to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the lambda for the given Id.

@param lambda_id [String] The Id of the lambda to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the user registration for the given user and application.

@param user_id [String] The Id of the user whose registration is being deleted. @param application_id [String] The Id of the application to remove the registration for. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the tenant for the given Id.

@param tenant_id [String] The Id of the tenant to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the theme for the given Id.

@param theme_id [String] The Id of the theme to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user.

@param user_id [String] The Id of the user to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users.

@param user_action_id [String] The Id of the user action to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the user action reason for the given Id.

@param user_action_reason_id [String] The Id of the user action reason to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.

@param request [Hash] The UserDeleteRequest. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to delete_users_by_query, use that method instead.

Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.

@param request [Hash] The UserDeleteRequest. @return [FusionAuth::ClientResponse] The ClientResponse object.

Deletes the webhook for the given Id.

@param webhook_id [String] The Id of the webhook to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Disable Two Factor authentication for a user.

@param user_id [String] The Id of the User for which you're disabling Two Factor authentication. @param code [String] The Two Factor code used verify the the caller knows the Two Factor secret. @return [FusionAuth::ClientResponse] The ClientResponse object.

Enable Two Factor authentication for a user.

@param user_id [String] The Id of the user to enable Two Factor authentication. @param request [Hash] The two factor enable request information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Exchanges an OAuth authorization code for an access token. If you will be using the Authorization Code grant, you will make a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.

@param code [String] The authorization code returned on the /oauth2/authorize response. @param client_id [String] The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. @param client_secret [String] (Optional) The client secret. This value will be required if client authentication is enabled. @param redirect_uri [String] The URI to redirect to upon a successful request. @return [FusionAuth::ClientResponse] The ClientResponse object.

Exchange a Refresh Token for an Access Token. If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.

@param refresh_token [String] The refresh token that you would like to use to exchange for an access token. @param client_id [String] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided. @param client_secret [String] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param scope [String] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request. @param user_code [String] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization. @return [FusionAuth::ClientResponse] The ClientResponse object.

Exchange a refresh token for a new JWT.

@param request [Hash] The refresh request. @return [FusionAuth::ClientResponse] The ClientResponse object.

Exchange User Credentials for a Token. If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token.

@param username [String] The login identifier of the user. The login identifier can be either the email or the username. @param password [String] The user’s password. @param client_id [String] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided. @param client_secret [String] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param scope [String] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request. @param user_code [String] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization. @return [FusionAuth::ClientResponse] The ClientResponse object.

Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.

@param request [Hash] The request that contains the information about the user so that they can be emailed. @return [FusionAuth::ClientResponse] The ClientResponse object.

Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system.

@param email [String] The email address of the user that needs a new verification email. @return [FusionAuth::ClientResponse] The ClientResponse object.

Generate a new RSA or EC key pair or an HMAC secret.

@param key_id [String] (Optional) The Id for the key. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the key. @return [FusionAuth::ClientResponse] The ClientResponse object.

Generate a new Application Registration Verification Id to be used with the Verify Registration API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system.

@param email [String] The email address of the user that needs a new verification email. @param application_id [String] The Id of the application to be verified. @return [FusionAuth::ClientResponse] The ClientResponse object.

Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.

@param encoded_jwt [String] The encoded JWT (access token). @return [FusionAuth::ClientResponse] The ClientResponse object.

Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.

@param request [Hash] The third-party login request that contains information from the third-party login providers that FusionAuth uses to reconcile the user's account. @return [FusionAuth::ClientResponse] The ClientResponse object.

Import an existing RSA or EC key pair or an HMAC secret.

@param key_id [String] (Optional) The Id for the key. If not provided a secure random UUID will be generated. @param request [Hash] The request object that contains all of the information used to create the key. @return [FusionAuth::ClientResponse] The ClientResponse object.

Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter.

@param request [Hash] The request that contains all of the information about all of the refresh tokens to import. @return [FusionAuth::ClientResponse] The ClientResponse object.

Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter.

@param request [Hash] The request that contains all of the information about all of the users to import. @return [FusionAuth::ClientResponse] The ClientResponse object.

Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid access token is properly signed and not expired.

This API may be used in an SSO configuration to issue new tokens for another application after the user has obtained a valid token from authentication.

@param application_id [String] The Application Id for which you are requesting a new access token be issued. @param encoded_jwt [String] The encoded JWT (access token). @param refresh_token [String] (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.

The target application represented by the applicationId request parameter must have refresh tokens enabled in order to receive a refresh token in the response.

Authenticates a user to FusionAuth.

This API optionally requires an API key. See Application.loginConfiguration.requireAuthentication.

@param request [Hash] The login request that contains the user credentials used to log them in. @return [FusionAuth::ClientResponse] The ClientResponse object.

Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting.

@param user_id [String] The Id of the user that was logged in. @param application_id [String] The Id of the application that they logged into. @param caller_ip_address [String] (Optional) The IP address of the end-user that is logging in. If a null value is provided the IP address will be that of the client or last proxy that sent the request. @return [FusionAuth::ClientResponse] The ClientResponse object.

The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies.

@param global [Bool] When this value is set to true all of the refresh tokens issued to the owner of the provided token will be revoked. @param refresh_token [String] (Optional) The refresh_token as a request parameter instead of coming in via a cookie. If provided this takes precedence over the cookie. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed by a registered identity provider. A 404 indicates the domain is not managed.

@param domain [String] The domain or email address to lookup. @return [FusionAuth::ClientResponse] The ClientResponse object.

Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.

@param action_id [String] The Id of the action to modify. This is technically the user action log id. @param request [Hash] The request that contains all of the information about the modification. @return [FusionAuth::ClientResponse] The ClientResponse object.

Complete a login request using a passwordless code

@param request [Hash] The passwordless login request that contains all of the information used to complete login. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the application with the given Id.

@param application_id [String] The Id of the application to update. @param request [Hash] The request that contains just the new application information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the application role with the given id for the application.

@param application_id [String] The Id of the application that the role belongs to. @param role_id [String] The Id of the role to update. @param request [Hash] The request that contains just the new role information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the connector with the given Id.

@param connector_id [String] The Id of the connector to update. @param request [Hash] The request that contains just the new connector information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the consent with the given Id.

@param consent_id [String] The Id of the consent to update. @param request [Hash] The request that contains just the new consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the email template with the given Id.

@param email_template_id [String] The Id of the email template to update. @param request [Hash] The request that contains just the new email template information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the group with the given Id.

@param group_id [String] The Id of the group to update. @param request [Hash] The request that contains just the new group information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the identity provider with the given Id.

@param identity_provider_id [String] The Id of the identity provider to update. @param request [Hash] The request object that contains just the updated identity provider information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the available integrations.

@param request [Hash] The request that contains just the new integration information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the lambda with the given Id.

@param lambda_id [String] The Id of the lambda to update. @param request [Hash] The request that contains just the new lambda information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the registration for the user with the given id and the application defined in the request.

@param user_id [String] The Id of the user whose registration is going to be updated. @param request [Hash] The request that contains just the new registration information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the system configuration.

@param request [Hash] The request that contains just the new system configuration information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the tenant with the given Id.

@param tenant_id [String] The Id of the tenant to update. @param request [Hash] The request that contains just the new tenant information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the theme with the given Id.

@param theme_id [String] The Id of the theme to update. @param request [Hash] The request that contains just the new theme information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the user with the given Id.

@param user_id [String] The Id of the user to update. @param request [Hash] The request that contains just the new user information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the user action with the given Id.

@param user_action_id [String] The Id of the user action to update. @param request [Hash] The request that contains just the new user action information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, the user action reason with the given Id.

@param user_action_reason_id [String] The Id of the user action reason to update. @param request [Hash] The request that contains just the new user action reason information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates, via PATCH, a single User consent by Id.

@param user_consent_id [String] The User Consent Id @param request [Hash] The request that contains just the new user consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Reactivates the application with the given Id.

@param application_id [String] The Id of the application to reactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Reactivates the user with the given Id.

@param user_id [String] The Id of the user to reactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Reactivates the user action with the given Id.

@param user_action_id [String] The Id of the user action to reactivate. @return [FusionAuth::ClientResponse] The ClientResponse object.

Reconcile a User to FusionAuth using JWT issued from another Identity Provider.

@param request [Hash] The reconcile request that contains the data to reconcile the User. @return [FusionAuth::ClientResponse] The ClientResponse object.

Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to ensure the index immediately current before making a query request to the search index.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User.

@param user_id [String] (Optional) The Id of the user being registered for the application and optionally created. @param request [Hash] The request that optionally contains the User and must contain the UserRegistration. @return [FusionAuth::ClientResponse] The ClientResponse object.

Removes a user from the family with the given id.

@param family_id [String] The id of the family to remove the user from. @param user_id [String] The id of the user to remove from the family. @return [FusionAuth::ClientResponse] The ClientResponse object.

Re-sends the verification email to the user.

@param email [String] The email address of the user that needs a new verification email. @return [FusionAuth::ClientResponse] The ClientResponse object.

Re-sends the verification email to the user. If the Application has configured a specific email template this will be used instead of the tenant configuration.

@param application_id [String] The unique Application Id to used to resolve an application specific email template. @param email [String] The email address of the user that needs a new verification email. @return [FusionAuth::ClientResponse] The ClientResponse object.

Re-sends the application registration verification email to the user.

@param email [String] The email address of the user that needs a new verification email. @param application_id [String] The Id of the application to be verified. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.

@param action_id [String] The Id of the action to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active, and inactive as well as non-time based actions.

@param user_id [String] The Id of the user to fetch the actions for. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.

@param user_id [String] The Id of the user to fetch the actions for. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the actions for the user with the given Id that are currently active. An active action means one that is time based and has not been canceled, and has not ended.

@param user_id [String] The Id of the user to fetch the actions for. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the application for the given id or all of the applications if the id is null.

@param application_id [String] (Optional) The application id. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the applications.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves a single audit log for the given Id.

@param audit_log_id [Int32] The Id of the audit log to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the connector with the given Id.

@param connector_id [String] The Id of the connector. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the connectors.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the Consent for the given Id.

@param consent_id [String] The Id of the consent. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the consent.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the daily active user report between the two instants. If you specify an application id, it will only return the daily active counts for that application.

@param application_id [String] (Optional) The application id. @param start [Int64] The start instant as UTC milliseconds since Epoch. @param _end [Int64] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the email template for the given Id. If you don't specify the id, this will return all of the email templates.

@param email_template_id [String] (Optional) The Id of the email template. @return [FusionAuth::ClientResponse] The ClientResponse object.

Creates a preview of the email template provided in the request. This allows you to preview an email template that hasn't been saved to the database yet. The entire email template does not need to be provided on the request. This will create the preview based on whatever is given.

@param request [Hash] The request that contains the email template and optionally a locale to render it in. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the email templates.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves a single event log for the given Id.

@param event_log_id [Int32] The Id of the event log to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the families that a user belongs to.

@param user_id [String] The User's id @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the members of a family by the unique Family Id.

@param family_id [String] The unique Id of the Family. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the form with the given Id.

@param form_id [String] The Id of the form. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the form field with the given Id.

@param field_id [String] The Id of the form field. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the forms fields

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the forms.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the group for the given Id.

@param group_id [String] The Id of the group. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the groups.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the identity provider for the given id or all of the identity providers if the id is null.

@param identity_provider_id [String] (Optional) The identity provider id. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the identity providers.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or has expired, or is not time based.

@param user_id [String] The Id of the user to fetch the actions for. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the applications that are currently inactive.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the user actions that are currently inactive.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the available integrations.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).

@param key_id [String] The Id of the public key (kid). @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.

@param application_id [String] The Id of the Application for which this key is used. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the key for the given Id.

@param key_id [String] The Id of the key. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the keys.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the lambda for the given Id.

@param lambda_id [String] The Id of the lambda. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the lambdas.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the lambdas for the provided type.

@param type [Hash] The type of the lambda to return. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application.

@param application_id [String] (Optional) The application id. @param start [Int64] The start instant as UTC milliseconds since Epoch. @param _end [Int64] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the monthly active user report between the two instants. If you specify an application id, it will only return the monthly active counts for that application.

@param application_id [String] (Optional) The application id. @param start [Int64] The start instant as UTC milliseconds since Epoch. @param _end [Int64] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the Oauth2 configuration for the application for the given Application Id.

@param application_id [String] The Id of the Application to retrieve OAuth configuration. @return [FusionAuth::ClientResponse] The ClientResponse object.

Returns the well known OpenID Configuration JSON document

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.

This API does not require an API key.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the password validation rules for a specific tenant.

This API does not require an API key.

@param tenant_id [String] The Id of the tenant. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the children for the given parent email address.

@param parent_email [String] The email of the parent. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the last number of login records.

@param offset [Int32] The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login. @param limit [Int32] (Optional, defaults to 10) The number of records to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the refresh tokens that belong to the user with the given Id.

@param user_id [String] The Id of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user registration for the user with the given id and the given application id.

@param user_id [String] The Id of the user. @param application_id [String] The Id of the application. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application.

@param application_id [String] (Optional) The application id. @param start [Int64] The start instant as UTC milliseconds since Epoch. @param _end [Int64] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the system configuration.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the tenant for the given Id.

@param tenant_id [String] The Id of the tenant. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the tenants.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the theme for the given Id.

@param theme_id [String] The Id of the theme. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the themes.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the totals report. This contains all of the total counts for each application and the global registration count.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user for the given Id.

@param user_id [String] The Id of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user action for the given Id. If you pass in null for the id, this will return all of the user actions.

@param user_action_id [String] (Optional) The Id of the user action. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all of the user action reasons.

@param user_action_reason_id [String] (Optional) The Id of the user action reason. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all the user action reasons.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the user actions.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username.

@param change_password_id [String] The unique change password Id that was sent via email or returned by the Forgot Password API. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user for the given email.

@param email [String] The email of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user for the loginId. The loginId can be either the username or the email.

@param login_id [String] The email or username of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user for the given username.

@param username [String] The username of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username.

@param verification_id [String] The unique verification Id that has been set on the user object. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the comments for the user with the given Id.

@param user_id [String] The Id of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieve a single User consent by Id.

@param user_consent_id [String] The User consent Id @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all of the consents for a User.

@param user_id [String] The User's Id @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the login counts for that application.

@param application_id [String] (Optional) The application id. @param user_id [String] The userId id. @param start [Int64] The start instant as UTC milliseconds since Epoch. @param _end [Int64] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the login counts for that application.

@param application_id [String] (Optional) The application id. @param login_id [String] The userId id. @param start [Int64] The start instant as UTC milliseconds since Epoch. @param _end [Int64] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the last number of login records for a user.

@param user_id [String] The Id of the user. @param offset [Int32] The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login. @param limit [Int32] (Optional, defaults to 10) The number of records to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web Token (JWT) for authentication.

@param encoded_jwt [String] The encoded JWT (access token). @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.

@param webhook_id [String] (Optional) The Id of the webhook. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves all the webhooks.

@return [FusionAuth::ClientResponse] The ClientResponse object.

Revokes a single refresh token, all tokens for a user or all tokens for an application. If you provide a user id and an application id, this will delete all the refresh tokens for that user for that application.

@param token [String] (Optional) The refresh token to delete. @param user_id [String] (Optional) The user id whose tokens to delete. @param application_id [String] (Optional) The application id of the tokens to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.

Revokes a single User consent by Id.

@param user_consent_id [String] The User Consent Id @return [FusionAuth::ClientResponse] The ClientResponse object.

Searches the audit logs with the specified criteria and pagination.

@param request [Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Searches the event logs with the specified criteria and pagination.

@param request [Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Searches the login records with the specified criteria and pagination.

@param request [Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the users for the given ids. If any id is invalid, it is ignored.

@param ids [Array] The user ids to search for. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to search_users_by_ids, use that method instead.

Retrieves the users for the given ids. If any id is invalid, it is ignored.

@param ids [Array] The user ids to search for. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the users for the given search criteria and pagination.

@param request [Hash] The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow, and sortFields. @return [FusionAuth::ClientResponse] The ClientResponse object.

Retrieves the users for the given search criteria and pagination.

@param request [Hash] The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow, and sortFields. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to search_users_by_query, use that method instead.

Send an email using an email template id. You can optionally provide requestData to access key value pairs in the email template.

@param email_template_id [String] The id for the template. @param request [Hash] The send email request that contains all of the information used to send the email. @return [FusionAuth::ClientResponse] The ClientResponse object.

Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family.

@param request [Hash] The request object that contains the parent email. @return [FusionAuth::ClientResponse] The ClientResponse object.

Send a passwordless authentication code in an email to complete login.

@param request [Hash] The passwordless send request that contains all of the information used to send an email containing a code. @return [FusionAuth::ClientResponse] The ClientResponse object.

Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.

@param request [Hash] The request object that contains all of the information used to send the code. @return [FusionAuth::ClientResponse] The ClientResponse object.

Send a Two Factor authentication code to allow the completion of Two Factor authentication.

@param two_factor_id [String] The Id returned by the Login API necessary to complete Two Factor authentication. @return [FusionAuth::ClientResponse] The ClientResponse object.

Begins a login request for a 3rd party login that requires user interaction such as HYPR.

@param request [Hash] The third-party login request that contains information from the third-party login providers that FusionAuth uses to reconcile the user's account. @return [FusionAuth::ClientResponse] The ClientResponse object.

Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code.

@param request [Hash] The passwordless start request that contains all of the information used to begin the passwordless login request. @return [FusionAuth::ClientResponse] The ClientResponse object.

Complete login using a 2FA challenge

@param request [Hash] The login request that contains the user credentials used to log them in. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the application with the given Id.

@param application_id [String] The Id of the application to update. @param request [Hash] The request that contains all of the new application information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the application role with the given id for the application.

@param application_id [String] The Id of the application that the role belongs to. @param role_id [String] The Id of the role to update. @param request [Hash] The request that contains all of the new role information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the connector with the given Id.

@param connector_id [String] The Id of the connector to update. @param request [Hash] The request object that contains all of the new connector information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the consent with the given Id.

@param consent_id [String] The Id of the consent to update. @param request [Hash] The request that contains all of the new consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the email template with the given Id.

@param email_template_id [String] The Id of the email template to update. @param request [Hash] The request that contains all of the new email template information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the form with the given Id.

@param form_id [String] The Id of the form to update. @param request [Hash] The request object that contains all of the new form information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the form field with the given Id.

@param field_id [String] The Id of the form field to update. @param request [Hash] The request object that contains all of the new form field information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the group with the given Id.

@param group_id [String] The Id of the group to update. @param request [Hash] The request that contains all of the new group information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the identity provider with the given Id.

@param identity_provider_id [String] The Id of the identity provider to update. @param request [Hash] The request object that contains the updated identity provider. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the available integrations.

@param request [Hash] The request that contains all of the new integration information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the key with the given Id.

@param key_id [String] The Id of the key to update. @param request [Hash] The request that contains all of the new key information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the lambda with the given Id.

@param lambda_id [String] The Id of the lambda to update. @param request [Hash] The request that contains all of the new lambda information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the registration for the user with the given id and the application defined in the request.

@param user_id [String] The Id of the user whose registration is going to be updated. @param request [Hash] The request that contains all of the new registration information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the system configuration.

@param request [Hash] The request that contains all of the new system configuration information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the tenant with the given Id.

@param tenant_id [String] The Id of the tenant to update. @param request [Hash] The request that contains all of the new tenant information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the theme with the given Id.

@param theme_id [String] The Id of the theme to update. @param request [Hash] The request that contains all of the new theme information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the user with the given Id.

@param user_id [String] The Id of the user to update. @param request [Hash] The request that contains all of the new user information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the user action with the given Id.

@param user_action_id [String] The Id of the user action to update. @param request [Hash] The request that contains all of the new user action information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the user action reason with the given Id.

@param user_action_reason_id [String] The Id of the user action reason to update. @param request [Hash] The request that contains all of the new user action reason information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates a single User consent by Id.

@param user_consent_id [String] The User Consent Id @param request [Hash] The request that contains the user consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Updates the webhook with the given Id.

@param webhook_id [String] The Id of the webhook to update. @param request [Hash] The request that contains all of the new webhook information. @return [FusionAuth::ClientResponse] The ClientResponse object.

Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant. If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.

@param user_code [String] The end-user verification code. @param client_id [String] The client id. @return [FusionAuth::ClientResponse] The ClientResponse object.

Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired.

This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims.

@param encoded_jwt [String] The encoded JWT (access token). @return [FusionAuth::ClientResponse] The ClientResponse object.

Confirms a email verification. The Id given is usually from an email sent to the user.

@param verification_id [String] The email verification id sent to the user. @return [FusionAuth::ClientResponse] The ClientResponse object.

Confirms an application registration. The Id given is usually from an email sent to the user.

@param verification_id [String] The registration verification Id sent to the user. @return [FusionAuth::ClientResponse] The ClientResponse object.