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).
Activates the FusionAuth Reactor using a license id and optionally a license text (for air-gapped deployments)
An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).
Adds a user to an existing family. The family id must be specified.
The id of the family.
The request object that contains all of the information used to determine which user to add to the family.
Cancels the user action.
The action id of the action to cancel.
The action request that contains the information about the cancellation.
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.
The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
The change password request that contains all of the information used to change the password.
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.
The change password request that contains all of the information used to change the password.
Adds a comment to the user's account.
The request object that contains all of the information used to create the user comment.
Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key.
If an API key is locked to a tenant, it can only create API Keys for that same tenant.
(Optional) The unique Id of the API key. If not provided a secure random Id will be generated.
The request object that contains all of the information needed to create the APIKey.
Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
(Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the application.
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.
The Id of the application to create the role on.
(Optional) The Id of the role. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the application role.
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.
The request object that contains all of the information used to create the audit log entry.
Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
(Optional) The Id for the connector. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the connector.
Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
(Optional) The Id for the consent. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the consent.
Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
(Optional) The Id for the template. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the email template.
Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
(Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the Entity.
Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
(Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the Entity Type.
Creates a new permission for an entity type. You must specify the id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
The Id of the entity type to create the permission on.
(Optional) The Id of the permission. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the permission.
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.
(Optional) The id for the family. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the family.
Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
(Optional) The Id for the form. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the form.
Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
(Optional) The Id for the form field. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the form field.
Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
(Optional) The Id for the group. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the group.
Creates a member in a group.
The request object that contains all of the information used to create the group member(s).
Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
(Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the identity provider.
Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
(Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the lambda.
Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
(Optional) The Id for the template. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the message template.
Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
(Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the messenger.
Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
(Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the tenant.
Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
(Optional) The Id for the theme. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the theme.
Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
(Optional) The Id for the user. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the user.
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.
(Optional) The Id for the user action. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the user action.
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.
(Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the user action reason.
Creates a single User consent.
(Optional) The Id for the User consent. If not provided a secure random UUID will be generated.
The request that contains the user consent information.
Link an external user from a 3rd party identity provider to a FusionAuth user.
The request object that contains all of the information used to link the FusionAuth user.
Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
(Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the webhook.
Deactivates the application with the given Id.
The Id of the application to deactivate.
Deactivates the FusionAuth Reactor.
Deactivates the user with the given Id.
The Id of the user to deactivate.
Deactivates the user action with the given Id.
The Id of the user action to deactivate.
Deactivates the users with the given ids.
The ids of the users to deactivate.
Deactivates the users with the given ids.
The ids of the users to deactivate.
Deletes the API key for the given Id.
The Id of the authentication API key to delete.
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.
The Id of the application to delete.
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.
The Id of the application to deactivate.
The Id of the role to delete.
Deletes the connector for the given Id.
The Id of the connector to delete.
Deletes the consent for the given Id.
The Id of the consent to delete.
Deletes the email template for the given Id.
The Id of the email template to delete.
Deletes the Entity for the given Id.
The Id of the Entity to delete.
Deletes an Entity Grant for the given User or Entity.
The Id of the Entity that the Entity Grant is being deleted for.
(Optional) The Id of the Entity that the Entity Grant is for.
(Optional) The Id of the User that the Entity Grant is for.
Deletes the Entity Type for the given Id.
The Id of the Entity Type to delete.
Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given permission from all grants that had it.
The Id of the entityType the the permission belongs to.
The Id of the permission to delete.
Deletes the form for the given Id.
The Id of the form to delete.
Deletes the form field for the given Id.
The Id of the form field to delete.
Deletes the group for the given Id.
The Id of the group to delete.
Removes users as members of a group.
The member request that contains all of the information used to remove members to the group.
Deletes the identity provider for the given Id.
The Id of the identity provider to delete.
Deletes the key for the given Id.
The Id of the key to delete.
Deletes the lambda for the given Id.
The Id of the lambda to delete.
Deletes the message template for the given Id.
The Id of the message template to delete.
Deletes the messenger for the given Id.
The Id of the messenger to delete.
Deletes the user registration for the given user and application.
The Id of the user whose registration is being deleted.
The Id of the application to remove the registration for.
Deletes the tenant for the given Id.
The Id of the tenant to delete.
Deletes the tenant for the given Id asynchronously. This method is helpful if you do not want to wait for the delete operation to complete.
The Id of the tenant to delete.
Deletes the theme for the given Id.
The Id of the theme to delete.
Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user.
The Id of the user to delete.
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.
The Id of the user action to delete.
Deletes the user action reason for the given Id.
The Id of the user action reason to delete.
Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
The unique Id of the identity provider.
The unique Id of the user in the 3rd party identity provider to unlink.
The unique Id of the FusionAuth user to unlink.
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.
The UserDeleteRequest.
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.
The UserDeleteRequest.
Deletes the webhook for the given Id.
The Id of the webhook to delete.
Disable Two Factor authentication for a user.
The Id of the User for which you're disabling Two Factor authentication.
The two-factor method identifier you wish to disable
The Two Factor code used verify the the caller knows the Two Factor secret.
Enable Two Factor authentication for a user.
The Id of the user to enable Two Factor authentication.
The two factor enable request information.
Exchanges an OAuth authorization code for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
The authorization code returned on the /oauth2/authorize response.
The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate.
(Optional) The client secret. This value will be required if client authentication is enabled.
The URI to redirect to upon a successful request.
Exchanges an OAuth authorization code and code_verifier for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
The authorization code returned on the /oauth2/authorize response.
(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.
(Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
The URI to redirect to upon a successful request.
The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
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.
The refresh token that you would like to use to exchange for an access token.
(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.
(Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
(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.
(Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
Exchange a refresh token for a new JWT.
The refresh request.
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.
The login identifier of the user. The login identifier can be either the email or the username.
The user’s password.
(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.
(Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
(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.
(Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
The request that contains the information about the user so that they can be emailed.
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.
The email address of the user that needs a new verification email.
Generate a new RSA or EC key pair or an HMAC secret.
(Optional) The Id for the key. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the key.
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.
The email address of the user that needs a new verification email.
The Id of the application to be verified.
Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes.
The Id of the user to generate new Two Factor recovery codes.
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.
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.
The encoded JWT (access token).
Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.
The third-party login request that contains information from the third-party login providers that FusionAuth uses to reconcile the user's account.
Import an existing RSA or EC key pair or an HMAC secret.
(Optional) The Id for the key. If not provided a secure random UUID will be generated.
The request object that contains all of the information used to create the key.
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.
The request that contains all of the information about all of the refresh tokens to import.
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.
The request that contains all of the information about all of the users to import.
Inspect an access token issued by FusionAuth.
The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.
The access token returned by this OAuth provider as the result of a successful authentication.
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.
The Application Id for which you are requesting a new access token be issued.
The encoded JWT (access token).
(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
.
The login request that contains the user credentials used to log them in.
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.
The Id of the user that was logged in.
The Id of the application that they logged into.
(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.
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.
When this value is set to true all of the refresh tokens issued to the owner of the provided token will be revoked.
(Optional) The refresh_token as a request parameter instead of coming in via a cookie. If provided this takes precedence over the cookie.
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.
The domain or email address to lookup.
Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.
The Id of the action to modify. This is technically the user action log id.
The request that contains all of the information about the modification.
Complete a login request using a passwordless code
The passwordless login request that contains all of the information used to complete login.
Updates an authentication API key by given id
The Id of the authentication key. If not provided a secure random api key will be generated.
The request object that contains all of the information needed to create the APIKey.
Updates, via PATCH, the application with the given Id.
The Id of the application to update.
The request that contains just the new application information.
Updates, via PATCH, the application role with the given id for the application.
The Id of the application that the role belongs to.
The Id of the role to update.
The request that contains just the new role information.
Updates, via PATCH, the connector with the given Id.
The Id of the connector to update.
The request that contains just the new connector information.
Updates, via PATCH, the consent with the given Id.
The Id of the consent to update.
The request that contains just the new consent information.
Updates, via PATCH, the email template with the given Id.
The Id of the email template to update.
The request that contains just the new email template information.
Updates, via PATCH, the Entity Type with the given Id.
The Id of the Entity Type to update.
The request that contains just the new Entity Type information.
Updates, via PATCH, the group with the given Id.
The Id of the group to update.
The request that contains just the new group information.
Updates, via PATCH, the identity provider with the given Id.
The Id of the identity provider to update.
The request object that contains just the updated identity provider information.
Updates, via PATCH, the available integrations.
The request that contains just the new integration information.
Updates, via PATCH, the lambda with the given Id.
The Id of the lambda to update.
The request that contains just the new lambda information.
Updates, via PATCH, the message template with the given Id.
The Id of the message template to update.
The request that contains just the new message template information.
Updates, via PATCH, the messenger with the given Id.
The Id of the messenger to update.
The request that contains just the new messenger information.
Updates, via PATCH, the registration for the user with the given id and the application defined in the request.
The Id of the user whose registration is going to be updated.
The request that contains just the new registration information.
Updates, via PATCH, the system configuration.
The request that contains just the new system configuration information.
Updates, via PATCH, the tenant with the given Id.
The Id of the tenant to update.
The request that contains just the new tenant information.
Updates, via PATCH, the theme with the given Id.
The Id of the theme to update.
The request that contains just the new theme information.
Updates, via PATCH, the user with the given Id.
The Id of the user to update.
The request that contains just the new user information.
Updates, via PATCH, the user action with the given Id.
The Id of the user action to update.
The request that contains just the new user action information.
Updates, via PATCH, the user action reason with the given Id.
The Id of the user action reason to update.
The request that contains just the new user action reason information.
Updates, via PATCH, a single User consent by Id.
The User Consent Id
The request that contains just the new user consent information.
Reactivates the application with the given Id.
The Id of the application to reactivate.
Reactivates the user with the given Id.
The Id of the user to reactivate.
Reactivates the user action with the given Id.
The Id of the user action to reactivate.
Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
The reconcile request that contains the data to reconcile the User.
Request a refresh of the Entity 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 Entity Create etc, you may wish to request a refresh to ensure the index immediately current before making a query request to the search index.
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.
Regenerates any keys that are used by the FusionAuth Reactor.
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.
(Optional) The Id of the user being registered for the application and optionally created.
The request that optionally contains the User and must contain the UserRegistration.
Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index.
You have been warned.
The request that contains the index name.
Removes a user from the family with the given id.
The id of the family to remove the user from.
The id of the user to remove from the family.
Re-sends the verification email to the user.
The email address of the user that needs a new verification email.
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.
The unique Application Id to used to resolve an application specific email template.
The email address of the user that needs a new verification email.
Re-sends the application registration verification email to the user.
The email address of the user that needs a new verification email.
The Id of the application to be verified.
Retrieves an authentication API key for the given id
The Id of the API key to retrieve.
Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
The Id of the action to retrieve.
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.
The Id of the user to fetch the actions for.
Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
The Id of the user to fetch the actions for.
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.
The Id of the user to fetch the actions for.
Retrieves the application for the given id or all of the applications if the id is null.
(Optional) The application id.
Retrieves all of the applications.
Retrieves a single audit log for the given Id.
The Id of the audit log to retrieve.
Retrieves the connector with the given Id.
The Id of the connector.
Retrieves all of the connectors.
Retrieves the Consent for the given Id.
The Id of the consent.
Retrieves all of the consent.
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.
(Optional) The application id.
The start instant as UTC milliseconds since Epoch.
The end instant as UTC milliseconds since Epoch.
Retrieves the email template for the given Id. If you don't specify the id, this will return all of the email templates.
(Optional) The Id of the email template.
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.
The request that contains the email template and optionally a locale to render it in.
Retrieves all of the email templates.
Retrieves the Entity for the given Id.
The Id of the Entity.
Retrieves an Entity Grant for the given Entity and User/Entity.
The Id of the Entity.
(Optional) The Id of the Entity that the Entity Grant is for.
(Optional) The Id of the User that the Entity Grant is for.
Retrieves the Entity Type for the given Id.
The Id of the Entity Type.
Retrieves all of the Entity Types.
Retrieves a single event log for the given Id.
The Id of the event log to retrieve.
Retrieves all of the families that a user belongs to.
The User's id
Retrieves all of the members of a family by the unique Family Id.
The unique Id of the Family.
Retrieves the form with the given Id.
The Id of the form.
Retrieves the form field with the given Id.
The Id of the form field.
Retrieves all of the forms fields
Retrieves all of the forms.
Retrieves the group for the given Id.
The Id of the group.
Retrieves all of the groups.
Retrieves the identity provider for the given id or all of the identity providers if the id is null.
The identity provider Id.
Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request may return multiple identity providers.
The type of the identity provider.
Retrieves all of the identity providers.
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.
The Id of the user to fetch the actions for.
Retrieves all of the applications that are currently inactive.
Retrieves all of the user actions that are currently inactive.
Retrieves the available integrations.
Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
The Id of the public key (kid).
Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
The Id of the Application for which this key is used.
Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
Retrieves the key for the given Id.
The Id of the key.
Retrieves all of the keys.
Retrieves the lambda for the given Id.
The Id of the lambda.
Retrieves all of the lambdas.
Retrieves all of the lambdas for the provided type.
The type of the lambda to return.
Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application.
(Optional) The application id.
The start instant as UTC milliseconds since Epoch.
The end instant as UTC milliseconds since Epoch.
Retrieves the message template for the given Id. If you don't specify the id, this will return all of the message templates.
(Optional) The Id of the message template.
Creates a preview of the message template provided in the request, normalized to a given locale.
The request that contains the email template and optionally a locale to render it in.
Retrieves all of the message templates.
Retrieves the messenger with the given Id.
The Id of the messenger.
Retrieves all of the messengers.
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.
(Optional) The application id.
The start instant as UTC milliseconds since Epoch.
The end instant as UTC milliseconds since Epoch.
Retrieves the Oauth2 configuration for the application for the given Application Id.
The Id of the Application to retrieve OAuth configuration.
Returns the well known OpenID Configuration JSON document
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.
Retrieves the password validation rules for a specific tenant.
This API does not require an API key.
The Id of the tenant.
Retrieves all of the children for the given parent email address.
The email of the parent.
Retrieves the FusionAuth Reactor status.
Retrieves the last number of login records.
The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
(Optional, defaults to 10) The number of records to retrieve.
Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..
The Id of the user.
Retrieves the refresh tokens that belong to the user with the given Id.
The Id of the user.
Retrieves the user registration for the user with the given id and the given application id.
The Id of the user.
The Id of the application.
Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application.
(Optional) The application id.
The start instant as UTC milliseconds since Epoch.
The end instant as UTC milliseconds since Epoch.
Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of 404 indicates no re-index is in progress.
Retrieves the system configuration.
Retrieves the tenant for the given Id.
The Id of the tenant.
Retrieves all of the tenants.
Retrieves the theme for the given Id.
The Id of the theme.
Retrieves all of the themes.
Retrieves the totals report. This contains all of the total counts for each application and the global registration count.
Retrieve two-factor recovery codes for a user.
The Id of the user to retrieve Two Factor recovery codes.
Retrieves the user for the given Id.
The Id of the user.
Retrieves the user action for the given Id. If you pass in null for the id, this will return all of the user actions.
(Optional) The Id of the user action.
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.
(Optional) The Id of the user action reason.
Retrieves all the user action reasons.
Retrieves all of the user actions.
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.
The unique change password Id that was sent via email or returned by the Forgot Password API.
Retrieves the user for the given email.
The email of the user.
Retrieves the user for the loginId. The loginId can be either the username or the email.
The email or username of the user.
Retrieves the user for the given username.
The username of the user.
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.
The unique verification Id that has been set on the user object.
Retrieves all of the comments for the user with the given Id.
The Id of the user.
Retrieve a single User consent by Id.
The User consent Id
Retrieves all of the consents for a User.
The User's Id
Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
The encoded JWT (access token).
Retrieve a single Identity Provider user (link).
The unique Id of the identity provider.
The unique Id of the user in the 3rd party identity provider.
The unique Id of the FusionAuth user.
Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.
(Optional) The unique Id of the identity provider. Specify this value to reduce the links returned to those for a particular IdP.
The unique Id of the user.
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.
(Optional) The application id.
The userId id.
The start instant as UTC milliseconds since Epoch.
The end instant as UTC milliseconds since Epoch.
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.
(Optional) The application id.
The userId id.
The start instant as UTC milliseconds since Epoch.
The end instant as UTC milliseconds since Epoch.
Retrieves the last number of login records for a user.
The Id of the user.
The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
(Optional, defaults to 10) The number of records to retrieve.
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.
The encoded JWT (access token).
Retrieves the FusionAuth version string.
Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
(Optional) The Id of the webhook.
Retrieves all the webhooks.
Revokes refresh tokens.
Usage examples:
Delete a single refresh token, pass in only the token. revokeRefreshToken(token)
Delete all refresh tokens for a user, pass in only the userId. revokeRefreshToken(null, userId)
Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId. revokeRefreshToken(null, userId, applicationId)
Delete all refresh tokens for an application revokeRefreshToken(null, null, applicationId)
Note: null
may be handled differently depending upon the programming language.
See also: (method names may vary by language... but you'll figure it out)
(Optional) The refresh token to delete.
(Optional) The user id whose tokens to delete.
(Optional) The application id of the tokens to delete.
Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
The unique Id of the token to delete.
Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so be careful with this API request.
The refresh token to delete.
Revoke all refresh tokens that belong to an application by applicationId.
The unique Id of the application that you want to delete all refresh tokens for.
Revoke all refresh tokens that belong to a user by user Id.
The unique Id of the user that you want to delete all refresh tokens for.
Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
The unique Id of the user that you want to delete all refresh tokens for.
The unique Id of the application that you want to delete refresh tokens for.
Revokes a single User consent by Id.
The User Consent Id
Searches the audit logs with the specified criteria and pagination.
The search criteria and pagination information.
Searches entities with the specified criteria and pagination.
The search criteria and pagination information.
Retrieves the entities for the given ids. If any id is invalid, it is ignored.
The entity ids to search for.
Searches Entity Grants with the specified criteria and pagination.
The search criteria and pagination information.
Searches the entity types with the specified criteria and pagination.
The search criteria and pagination information.
Searches the event logs with the specified criteria and pagination.
The search criteria and pagination information.
Searches the login records with the specified criteria and pagination.
The search criteria and pagination information.
Retrieves the users for the given ids. If any id is invalid, it is ignored.
The user ids to search for.
Retrieves the users for the given ids. If any id is invalid, it is ignored.
The user ids to search for.
Retrieves the users for the given search criteria and pagination.
The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow, and sortFields.
Retrieves the users for the given search criteria and pagination.
The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow, and sortFields.
Send an email using an email template id. You can optionally provide requestData
to access key value
pairs in the email template.
The id for the template.
The send email request that contains all of the information used to send the email.
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.
The request object that contains the parent email.
Send a passwordless authentication code in an email to complete login.
The passwordless send request that contains all of the information used to send an email containing a code.
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
The request object that contains all of the information used to send the code.
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
The request object that contains all of the information used to send the code.
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
The Id returned by the Login API necessary to complete Two Factor authentication.
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
The Id returned by the Login API necessary to complete Two Factor authentication.
The Two Factor send request that contains all of the information used to send the Two Factor code to the user.
Sets whether and how cookies will be sent with each request.
The value that indicates whether and how cookies will be sent.
Sets the tenant id, that will be included in the X-FusionAuth-TenantId header.
The value of the X-FusionAuth-TenantId header.
creates a rest client
The RESTClient that will be used to call.
Begins a login request for a 3rd party login that requires user interaction such as HYPR.
The third-party login request that contains information from the third-party login providers that FusionAuth uses to reconcile the user's account.
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.
The passwordless start request that contains all of the information used to begin the passwordless login request.
Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code.
This API is intended to allow you to begin a Two-Factor login outside of a normal login that originated from the Login API (/api/login).
The Two-Factor start request that contains all of the information used to begin the Two-Factor login request.
Complete login using a 2FA challenge
The login request that contains the user credentials used to log them in.
Updates an API key by given id
The Id of the API key to update.
The request object that contains all of the information used to create the API Key.
Updates the application with the given Id.
The Id of the application to update.
The request that contains all of the new application information.
Updates the application role with the given id for the application.
The Id of the application that the role belongs to.
The Id of the role to update.
The request that contains all of the new role information.
Updates the connector with the given Id.
The Id of the connector to update.
The request object that contains all of the new connector information.
Updates the consent with the given Id.
The Id of the consent to update.
The request that contains all of the new consent information.
Updates the email template with the given Id.
The Id of the email template to update.
The request that contains all of the new email template information.
Updates the Entity with the given Id.
The Id of the Entity to update.
The request that contains all of the new Entity information.
Updates the Entity Type with the given Id.
The Id of the Entity Type to update.
The request that contains all of the new Entity Type information.
Updates the permission with the given id for the entity type.
The Id of the entityType that the permission belongs to.
The Id of the permission to update.
The request that contains all of the new permission information.
Updates the form with the given Id.
The Id of the form to update.
The request object that contains all of the new form information.
Updates the form field with the given Id.
The Id of the form field to update.
The request object that contains all of the new form field information.
Updates the group with the given Id.
The Id of the group to update.
The request that contains all of the new group information.
Updates the identity provider with the given Id.
The Id of the identity provider to update.
The request object that contains the updated identity provider.
Updates the available integrations.
The request that contains all of the new integration information.
Updates the key with the given Id.
The Id of the key to update.
The request that contains all of the new key information.
Updates the lambda with the given Id.
The Id of the lambda to update.
The request that contains all of the new lambda information.
Updates the message template with the given Id.
The Id of the message template to update.
The request that contains all of the new message template information.
Updates the messenger with the given Id.
The Id of the messenger to update.
The request object that contains all of the new messenger information.
Updates the registration for the user with the given id and the application defined in the request.
The Id of the user whose registration is going to be updated.
The request that contains all of the new registration information.
Updates the system configuration.
The request that contains all of the new system configuration information.
Updates the tenant with the given Id.
The Id of the tenant to update.
The request that contains all of the new tenant information.
Updates the theme with the given Id.
The Id of the theme to update.
The request that contains all of the new theme information.
Updates the user with the given Id.
The Id of the user to update.
The request that contains all of the new user information.
Updates the user action with the given Id.
The Id of the user action to update.
The request that contains all of the new user action information.
Updates the user action reason with the given Id.
The Id of the user action reason to update.
The request that contains all of the new user action reason information.
Updates a single User consent by Id.
The User Consent Id
The request that contains the user consent information.
Updates the webhook with the given Id.
The Id of the webhook to update.
The request that contains all of the new webhook information.
Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
The Id of the Entity that the User/Entity is being granted access to.
The request object that contains all of the information used to create the Entity Grant.
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.
The end-user verification code.
The client id.
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.
The encoded JWT (access token).
Confirms a email verification. The Id given is usually from an email sent to the user.
The email verification id sent to the user.
Confirms a user's email address.
The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's email address and mark the user's email address as verified.
The request that contains the verificationId and optional one-time use code paired with the verificationId.
Confirms an application registration. The Id given is usually from an email sent to the user.
The registration verification Id sent to the user.
Confirms a user's registration.
The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's registration and mark the user's registration as verified.
The request that contains the verificationId and optional one-time use code paired with the verificationId.
Generated using TypeDoc
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.