public class FusionAuthClient extends Object
When any method is called the return value is always a ClientResponse object. When an API call was successful, the response will contain the response from the server. This might be empty or contain an success object or an error object. If there was a validation error or any other type of error, this will return the Errors object in the response. Additionally, if FusionAuth could not be contacted because it is down or experiencing a failure, the response will contain an Exception, which could be an IOException.
Modifier and Type | Field and Description |
---|---|
int |
connectTimeout |
static com.fasterxml.jackson.databind.ObjectMapper |
objectMapper |
int |
readTimeout |
static String |
TENANT_ID_HEADER |
Constructor and Description |
---|
FusionAuthClient(String apiKey,
String baseURL) |
FusionAuthClient(String apiKey,
String baseURL,
int connectTimeout,
int readTimeout) |
FusionAuthClient(String apiKey,
String baseURL,
int connectTimeout,
int readTimeout,
String tenantId) |
FusionAuthClient(String apiKey,
String baseURL,
String tenantId) |
Modifier and Type | Method and Description |
---|---|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
actionUser(ActionRequest request)
Takes an action on a user.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
activateReactor(ReactorRequest request)
Activates the FusionAuth Reactor using a license id and optionally a license text (for air-gapped deployments)
|
com.inversoft.rest.ClientResponse<FamilyResponse,com.inversoft.error.Errors> |
addUserToFamily(UUID familyId,
FamilyRequest request)
Adds a user to an existing family.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
cancelAction(UUID actionId,
ActionRequest request)
Cancels the user action.
|
com.inversoft.rest.ClientResponse<ChangePasswordResponse,com.inversoft.error.Errors> |
changePassword(String changePasswordId,
ChangePasswordRequest request)
Changes a user's password using the change password Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
changePasswordByIdentity(ChangePasswordRequest request)
Changes a user's password using their identity (login id and password).
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
commentOnUser(UserCommentRequest request)
Adds a comment to the user's account.
|
com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> |
createAPIKey(UUID keyId,
APIKeyRequest request)
Creates an API key.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
createApplication(UUID applicationId,
ApplicationRequest request)
Creates an application.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
createApplicationRole(UUID applicationId,
UUID roleId,
ApplicationRequest request)
Creates a new role for an application.
|
com.inversoft.rest.ClientResponse<AuditLogResponse,com.inversoft.error.Errors> |
createAuditLog(AuditLogRequest request)
Creates an audit log with the message and user name (usually an email).
|
com.inversoft.rest.ClientResponse<ConnectorResponse,com.inversoft.error.Errors> |
createConnector(UUID connectorId,
ConnectorRequest request)
Creates a connector.
|
com.inversoft.rest.ClientResponse<ConsentResponse,com.inversoft.error.Errors> |
createConsent(UUID consentId,
ConsentRequest request)
Creates a user consent type.
|
com.inversoft.rest.ClientResponse<EmailTemplateResponse,com.inversoft.error.Errors> |
createEmailTemplate(UUID emailTemplateId,
EmailTemplateRequest request)
Creates an email template.
|
com.inversoft.rest.ClientResponse<EntityResponse,com.inversoft.error.Errors> |
createEntity(UUID entityId,
EntityRequest request)
Creates an Entity.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
createEntityType(UUID entityTypeId,
EntityTypeRequest request)
Creates a Entity Type.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
createEntityTypePermission(UUID entityTypeId,
UUID permissionId,
EntityTypeRequest request)
Creates a new permission for an entity type.
|
com.inversoft.rest.ClientResponse<FamilyResponse,com.inversoft.error.Errors> |
createFamily(UUID familyId,
FamilyRequest request)
Creates a family with the user id in the request as the owner and sole member of the family.
|
com.inversoft.rest.ClientResponse<FormResponse,com.inversoft.error.Errors> |
createForm(UUID formId,
FormRequest request)
Creates a form.
|
com.inversoft.rest.ClientResponse<FormFieldResponse,com.inversoft.error.Errors> |
createFormField(UUID fieldId,
FormFieldRequest request)
Creates a form field.
|
com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> |
createGroup(UUID groupId,
GroupRequest request)
Creates a group.
|
com.inversoft.rest.ClientResponse<MemberResponse,com.inversoft.error.Errors> |
createGroupMembers(MemberRequest request)
Creates a member in a group.
|
com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> |
createIdentityProvider(UUID identityProviderId,
IdentityProviderRequest request)
Creates an identity provider.
|
com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> |
createLambda(UUID lambdaId,
LambdaRequest request)
Creates a Lambda.
|
com.inversoft.rest.ClientResponse<MessageTemplateResponse,com.inversoft.error.Errors> |
createMessageTemplate(UUID messageTemplateId,
MessageTemplateRequest request)
Creates an message template.
|
com.inversoft.rest.ClientResponse<MessengerResponse,com.inversoft.error.Errors> |
createMessenger(UUID messengerId,
MessengerRequest request)
Creates a messenger.
|
com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> |
createTenant(UUID tenantId,
TenantRequest request)
Creates a tenant.
|
com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> |
createTheme(UUID themeId,
ThemeRequest request)
Creates a Theme.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
createUser(UUID userId,
UserRequest request)
Creates a user.
|
com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> |
createUserAction(UUID userActionId,
UserActionRequest request)
Creates a user action.
|
com.inversoft.rest.ClientResponse<UserActionReasonResponse,com.inversoft.error.Errors> |
createUserActionReason(UUID userActionReasonId,
UserActionReasonRequest request)
Creates a user reason.
|
com.inversoft.rest.ClientResponse<UserConsentResponse,com.inversoft.error.Errors> |
createUserConsent(UUID userConsentId,
UserConsentRequest request)
Creates a single User consent.
|
com.inversoft.rest.ClientResponse<WebhookResponse,com.inversoft.error.Errors> |
createWebhook(UUID webhookId,
WebhookRequest request)
Creates a webhook.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deactivateApplication(UUID applicationId)
Deactivates the application with the given Id.
|
com.inversoft.rest.ClientResponse<Void,Void> |
deactivateReactor()
Deactivates the FusionAuth Reactor.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deactivateUser(UUID userId)
Deactivates the user with the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deactivateUserAction(UUID userActionId)
Deactivates the user action with the given Id.
|
com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> |
deactivateUsers(Collection<UUID> userIds)
Deprecated.
This method has been renamed to deactivateUsersByIds, use that method instead.
|
com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> |
deactivateUsersByIds(Collection<UUID> userIds)
Deactivates the users with the given ids.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteAPIKey(UUID keyId)
Deletes the API key for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteApplication(UUID applicationId)
Hard deletes an application.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteApplicationRole(UUID applicationId,
UUID roleId)
Hard deletes an application role.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteConnector(UUID connectorId)
Deletes the connector for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteConsent(UUID consentId)
Deletes the consent for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteEmailTemplate(UUID emailTemplateId)
Deletes the email template for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteEntity(UUID entityId)
Deletes the Entity for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteEntityGrant(UUID entityId,
UUID recipientEntityId,
UUID userId)
Deletes an Entity Grant for the given User or Entity.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteEntityType(UUID entityTypeId)
Deletes the Entity Type for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteEntityTypePermission(UUID entityTypeId,
UUID permissionId)
Hard deletes a permission.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteForm(UUID formId)
Deletes the form for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteFormField(UUID fieldId)
Deletes the form field for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteGroup(UUID groupId)
Deletes the group for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteGroupMembers(MemberDeleteRequest request)
Removes users as members of a group.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteIdentityProvider(UUID identityProviderId)
Deletes the identity provider for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteKey(UUID keyId)
Deletes the key for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteLambda(UUID lambdaId)
Deletes the lambda for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteMessageTemplate(UUID messageTemplateId)
Deletes the message template for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteMessenger(UUID messengerId)
Deletes the messenger for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteRegistration(UUID userId,
UUID applicationId)
Deletes the user registration for the given user and application.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteTenant(UUID tenantId)
Deletes the tenant for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteTenantAsync(UUID tenantId)
Deletes the tenant for the given Id asynchronously.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteTheme(UUID themeId)
Deletes the theme for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteUser(UUID userId)
Deletes the user for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteUserAction(UUID userActionId)
Deletes the user action for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteUserActionReason(UUID userActionReasonId)
Deletes the user action reason for the given Id.
|
com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> |
deleteUsers(UserDeleteRequest request)
Deprecated.
This method has been renamed to deleteUsersByQuery, use that method instead.
|
com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> |
deleteUsersByQuery(UserDeleteRequest request)
Deletes the users with the given ids, or users matching the provided JSON query or queryString.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
deleteWebhook(UUID webhookId)
Deletes the webhook for the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
disableTwoFactor(UUID userId,
String methodId,
String code)
Disable Two Factor authentication for a user.
|
com.inversoft.rest.ClientResponse<TwoFactorResponse,com.inversoft.error.Errors> |
enableTwoFactor(UUID userId,
TwoFactorRequest request)
Enable Two Factor authentication for a user.
|
com.inversoft.rest.ClientResponse<AccessToken,OAuthError> |
exchangeOAuthCodeForAccessToken(String code,
String client_id,
String client_secret,
String redirect_uri)
Exchanges an OAuth authorization code for an access token.
|
com.inversoft.rest.ClientResponse<AccessToken,OAuthError> |
exchangeOAuthCodeForAccessTokenUsingPKCE(String code,
String client_id,
String client_secret,
String redirect_uri,
String code_verifier)
Exchanges an OAuth authorization code and code_verifier for an access token.
|
com.inversoft.rest.ClientResponse<AccessToken,OAuthError> |
exchangeRefreshTokenForAccessToken(String refresh_token,
String client_id,
String client_secret,
String scope,
String user_code)
Exchange a Refresh Token for an Access Token.
|
com.inversoft.rest.ClientResponse<JWTRefreshResponse,com.inversoft.error.Errors> |
exchangeRefreshTokenForJWT(RefreshRequest request)
Exchange a refresh token for a new JWT.
|
com.inversoft.rest.ClientResponse<AccessToken,OAuthError> |
exchangeUserCredentialsForAccessToken(String username,
String password,
String client_id,
String client_secret,
String scope,
String user_code)
Exchange User Credentials for a Token.
|
com.inversoft.rest.ClientResponse<ForgotPasswordResponse,com.inversoft.error.Errors> |
forgotPassword(ForgotPasswordRequest request)
Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
|
com.inversoft.rest.ClientResponse<VerifyEmailResponse,Void> |
generateEmailVerificationId(String email)
Generate a new Email Verification Id to be used with the Verify Email API.
|
com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> |
generateKey(UUID keyId,
KeyRequest request)
Generate a new RSA or EC key pair or an HMAC secret.
|
com.inversoft.rest.ClientResponse<VerifyRegistrationResponse,Void> |
generateRegistrationVerificationId(String email,
UUID applicationId)
Generate a new Application Registration Verification Id to be used with the Verify Registration API.
|
com.inversoft.rest.ClientResponse<TwoFactorRecoveryCodeResponse,com.inversoft.error.Errors> |
generateTwoFactorRecoveryCodes(UUID userId)
Generate two-factor recovery codes for a user.
|
com.inversoft.rest.ClientResponse<SecretResponse,Void> |
generateTwoFactorSecret()
Generate a Two Factor secret that can be used to enable Two Factor authentication for a User.
|
com.inversoft.rest.ClientResponse<SecretResponse,Void> |
generateTwoFactorSecretUsingJWT(String encodedJWT)
Generate a Two Factor secret that can be used to enable Two Factor authentication for a User.
|
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
identityProviderLogin(IdentityProviderLoginRequest request)
Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other
login systems.
|
com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> |
importKey(UUID keyId,
KeyRequest request)
Import an existing RSA or EC key pair or an HMAC secret.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
importRefreshTokens(RefreshTokenImportRequest request)
Bulk imports refresh tokens.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
importUsers(ImportRequest request)
Bulk imports users.
|
com.inversoft.rest.ClientResponse<IntrospectResponse,OAuthError> |
introspectAccessToken(String client_id,
String token)
Inspect an access token issued by FusionAuth.
|
com.inversoft.rest.ClientResponse<IssueResponse,com.inversoft.error.Errors> |
issueJWT(UUID applicationId,
String encodedJWT,
String refreshToken)
Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid.
|
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
login(LoginRequest request)
Authenticates a user to FusionAuth.
|
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
loginPing(UUID userId,
UUID applicationId,
String callerIPAddress)
Sends a ping to FusionAuth indicating that the user was automatically logged into an application.
|
com.inversoft.rest.ClientResponse<Void,Void> |
logout(boolean global,
String refreshToken)
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.
|
com.inversoft.rest.ClientResponse<LookupResponse,Void> |
lookupIdentityProvider(String domain)
Retrieves the identity provider for the given domain.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
modifyAction(UUID actionId,
ActionRequest request)
Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the
action.
|
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
passwordlessLogin(PasswordlessLoginRequest request)
Complete a login request using a passwordless code
|
com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> |
patchAPIKey(UUID keyId,
APIKeyRequest request)
Updates an authentication API key by given id
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
patchApplication(UUID applicationId,
Map<String,Object> request)
Updates, via PATCH, the application with the given Id.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
patchApplicationRole(UUID applicationId,
UUID roleId,
Map<String,Object> request)
Updates, via PATCH, the application role with the given id for the application.
|
com.inversoft.rest.ClientResponse<ConnectorResponse,com.inversoft.error.Errors> |
patchConnector(UUID connectorId,
Map<String,Object> request)
Updates, via PATCH, the connector with the given Id.
|
com.inversoft.rest.ClientResponse<ConsentResponse,com.inversoft.error.Errors> |
patchConsent(UUID consentId,
Map<String,Object> request)
Updates, via PATCH, the consent with the given Id.
|
com.inversoft.rest.ClientResponse<EmailTemplateResponse,com.inversoft.error.Errors> |
patchEmailTemplate(UUID emailTemplateId,
Map<String,Object> request)
Updates, via PATCH, the email template with the given Id.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
patchEntityType(UUID entityTypeId,
Map<String,Object> request)
Updates, via PATCH, the Entity Type with the given Id.
|
com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> |
patchGroup(UUID groupId,
Map<String,Object> request)
Updates, via PATCH, the group with the given Id.
|
com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> |
patchIdentityProvider(UUID identityProviderId,
Map<String,Object> request)
Updates, via PATCH, the identity provider with the given Id.
|
com.inversoft.rest.ClientResponse<IntegrationResponse,com.inversoft.error.Errors> |
patchIntegrations(Map<String,Object> request)
Updates, via PATCH, the available integrations.
|
com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> |
patchLambda(UUID lambdaId,
Map<String,Object> request)
Updates, via PATCH, the lambda with the given Id.
|
com.inversoft.rest.ClientResponse<MessageTemplateResponse,com.inversoft.error.Errors> |
patchMessageTemplate(UUID messageTemplateId,
Map<String,Object> request)
Updates, via PATCH, the message template with the given Id.
|
com.inversoft.rest.ClientResponse<MessengerResponse,com.inversoft.error.Errors> |
patchMessenger(UUID messengerId,
Map<String,Object> request)
Updates, via PATCH, the messenger with the given Id.
|
com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> |
patchRegistration(UUID userId,
Map<String,Object> request)
Updates, via PATCH, the registration for the user with the given id and the application defined in the request.
|
com.inversoft.rest.ClientResponse<SystemConfigurationResponse,com.inversoft.error.Errors> |
patchSystemConfiguration(Map<String,Object> request)
Updates, via PATCH, the system configuration.
|
com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> |
patchTenant(UUID tenantId,
Map<String,Object> request)
Updates, via PATCH, the tenant with the given Id.
|
com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> |
patchTheme(UUID themeId,
Map<String,Object> request)
Updates, via PATCH, the theme with the given Id.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
patchUser(UUID userId,
Map<String,Object> request)
Updates, via PATCH, the user with the given Id.
|
com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> |
patchUserAction(UUID userActionId,
Map<String,Object> request)
Updates, via PATCH, the user action with the given Id.
|
com.inversoft.rest.ClientResponse<UserActionReasonResponse,com.inversoft.error.Errors> |
patchUserActionReason(UUID userActionReasonId,
Map<String,Object> request)
Updates, via PATCH, the user action reason with the given Id.
|
com.inversoft.rest.ClientResponse<UserConsentResponse,com.inversoft.error.Errors> |
patchUserConsent(UUID userConsentId,
Map<String,Object> request)
Updates, via PATCH, a single User consent by Id.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
reactivateApplication(UUID applicationId)
Reactivates the application with the given Id.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
reactivateUser(UUID userId)
Reactivates the user with the given Id.
|
com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> |
reactivateUserAction(UUID userActionId)
Reactivates the user action with the given Id.
|
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
reconcileJWT(IdentityProviderLoginRequest request)
Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
|
com.inversoft.rest.ClientResponse<Void,Void> |
refreshEntitySearchIndex()
Request a refresh of the Entity search index.
|
com.inversoft.rest.ClientResponse<Void,Void> |
refreshUserSearchIndex()
Request a refresh of the User search index.
|
com.inversoft.rest.ClientResponse<Void,Void> |
regenerateReactorKeys()
Regenerates any keys that are used by the FusionAuth Reactor.
|
com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> |
register(UUID userId,
RegistrationRequest request)
Registers a user for an application.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
removeUserFromFamily(UUID familyId,
UUID userId)
Removes a user from the family with the given id.
|
com.inversoft.rest.ClientResponse<VerifyEmailResponse,com.inversoft.error.Errors> |
resendEmailVerification(String email)
Re-sends the verification email to the user.
|
com.inversoft.rest.ClientResponse<VerifyEmailResponse,com.inversoft.error.Errors> |
resendEmailVerificationWithApplicationTemplate(UUID applicationId,
String email)
Re-sends the verification email to the user.
|
com.inversoft.rest.ClientResponse<VerifyRegistrationResponse,com.inversoft.error.Errors> |
resendRegistrationVerification(String email,
UUID applicationId)
Re-sends the application registration verification email to the user.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
retrieveAction(UUID actionId)
Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
retrieveActions(UUID userId)
Retrieves all of the actions for the user with the given Id.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
retrieveActionsPreventingLogin(UUID userId)
Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
retrieveActiveActions(UUID userId)
Retrieves all of the actions for the user with the given Id that are currently active.
|
com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> |
retrieveAPIKey(UUID keyId)
Retrieves an authentication API key for the given id
|
com.inversoft.rest.ClientResponse<ApplicationResponse,Void> |
retrieveApplication(UUID applicationId)
Retrieves the application for the given id or all of the applications if the id is null.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,Void> |
retrieveApplications()
Retrieves all of the applications.
|
com.inversoft.rest.ClientResponse<AuditLogResponse,com.inversoft.error.Errors> |
retrieveAuditLog(Integer auditLogId)
Retrieves a single audit log for the given Id.
|
com.inversoft.rest.ClientResponse<ConnectorResponse,Void> |
retrieveConnector(UUID connectorId)
Retrieves the connector with the given Id.
|
com.inversoft.rest.ClientResponse<ConnectorResponse,Void> |
retrieveConnectors()
Retrieves all of the connectors.
|
com.inversoft.rest.ClientResponse<ConsentResponse,Void> |
retrieveConsent(UUID consentId)
Retrieves the Consent for the given Id.
|
com.inversoft.rest.ClientResponse<ConsentResponse,Void> |
retrieveConsents()
Retrieves all of the consent.
|
com.inversoft.rest.ClientResponse<DailyActiveUserReportResponse,com.inversoft.error.Errors> |
retrieveDailyActiveReport(UUID applicationId,
long start,
long end)
Retrieves the daily active user report between the two instants.
|
com.inversoft.rest.ClientResponse<EmailTemplateResponse,Void> |
retrieveEmailTemplate(UUID emailTemplateId)
Retrieves the email template for the given Id.
|
com.inversoft.rest.ClientResponse<PreviewResponse,com.inversoft.error.Errors> |
retrieveEmailTemplatePreview(PreviewRequest request)
Creates a preview of the email template provided in the request.
|
com.inversoft.rest.ClientResponse<EmailTemplateResponse,Void> |
retrieveEmailTemplates()
Retrieves all of the email templates.
|
com.inversoft.rest.ClientResponse<EntityResponse,com.inversoft.error.Errors> |
retrieveEntity(UUID entityId)
Retrieves the Entity for the given Id.
|
com.inversoft.rest.ClientResponse<EntityGrantResponse,com.inversoft.error.Errors> |
retrieveEntityGrant(UUID entityId,
UUID recipientEntityId,
UUID userId)
Retrieves an Entity Grant for the given Entity and User/Entity.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
retrieveEntityType(UUID entityTypeId)
Retrieves the Entity Type for the given Id.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
retrieveEntityTypes()
Retrieves all of the Entity Types.
|
com.inversoft.rest.ClientResponse<EventLogResponse,com.inversoft.error.Errors> |
retrieveEventLog(Integer eventLogId)
Retrieves a single event log for the given Id.
|
com.inversoft.rest.ClientResponse<FamilyResponse,Void> |
retrieveFamilies(UUID userId)
Retrieves all of the families that a user belongs to.
|
com.inversoft.rest.ClientResponse<FamilyResponse,Void> |
retrieveFamilyMembersByFamilyId(UUID familyId)
Retrieves all of the members of a family by the unique Family Id.
|
com.inversoft.rest.ClientResponse<FormResponse,Void> |
retrieveForm(UUID formId)
Retrieves the form with the given Id.
|
com.inversoft.rest.ClientResponse<FormFieldResponse,Void> |
retrieveFormField(UUID fieldId)
Retrieves the form field with the given Id.
|
com.inversoft.rest.ClientResponse<FormFieldResponse,Void> |
retrieveFormFields()
Retrieves all of the forms fields
|
com.inversoft.rest.ClientResponse<FormResponse,Void> |
retrieveForms()
Retrieves all of the forms.
|
com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> |
retrieveGroup(UUID groupId)
Retrieves the group for the given Id.
|
com.inversoft.rest.ClientResponse<GroupResponse,Void> |
retrieveGroups()
Retrieves all of the groups.
|
com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> |
retrieveIdentityProvider(UUID identityProviderId)
Retrieves the identity provider for the given id or all of the identity providers if the id is null.
|
com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> |
retrieveIdentityProviderByType(IdentityProviderType type)
Retrieves one or more identity provider for the given type.
|
com.inversoft.rest.ClientResponse<IdentityProviderResponse,Void> |
retrieveIdentityProviders()
Retrieves all of the identity providers.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
retrieveInactiveActions(UUID userId)
Retrieves all of the actions for the user with the given Id that are currently inactive.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,Void> |
retrieveInactiveApplications()
Retrieves all of the applications that are currently inactive.
|
com.inversoft.rest.ClientResponse<UserActionResponse,Void> |
retrieveInactiveUserActions()
Retrieves all of the user actions that are currently inactive.
|
com.inversoft.rest.ClientResponse<IntegrationResponse,Void> |
retrieveIntegration()
Retrieves the available integrations.
|
com.inversoft.rest.ClientResponse<JWKSResponse,Void> |
retrieveJsonWebKeySet()
Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
|
com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> |
retrieveJWTPublicKey(String keyId)
Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
|
com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> |
retrieveJWTPublicKeyByApplicationId(String applicationId)
Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
|
com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> |
retrieveJWTPublicKeys()
Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
|
com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> |
retrieveKey(UUID keyId)
Retrieves the key for the given Id.
|
com.inversoft.rest.ClientResponse<KeyResponse,Void> |
retrieveKeys()
Retrieves all of the keys.
|
com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> |
retrieveLambda(UUID lambdaId)
Retrieves the lambda for the given Id.
|
com.inversoft.rest.ClientResponse<LambdaResponse,Void> |
retrieveLambdas()
Retrieves all of the lambdas.
|
com.inversoft.rest.ClientResponse<LambdaResponse,Void> |
retrieveLambdasByType(LambdaType type)
Retrieves all of the lambdas for the provided type.
|
com.inversoft.rest.ClientResponse<LoginReportResponse,com.inversoft.error.Errors> |
retrieveLoginReport(UUID applicationId,
long start,
long end)
Retrieves the login report between the two instants.
|
com.inversoft.rest.ClientResponse<MessageTemplateResponse,Void> |
retrieveMessageTemplate(UUID messageTemplateId)
Retrieves the message template for the given Id.
|
com.inversoft.rest.ClientResponse<PreviewMessageTemplateResponse,com.inversoft.error.Errors> |
retrieveMessageTemplatePreview(PreviewMessageTemplateRequest request)
Creates a preview of the message template provided in the request, normalized to a given locale.
|
com.inversoft.rest.ClientResponse<MessageTemplateResponse,Void> |
retrieveMessageTemplates()
Retrieves all of the message templates.
|
com.inversoft.rest.ClientResponse<MessengerResponse,Void> |
retrieveMessenger(UUID messengerId)
Retrieves the messenger with the given Id.
|
com.inversoft.rest.ClientResponse<MessengerResponse,Void> |
retrieveMessengers()
Retrieves all of the messengers.
|
com.inversoft.rest.ClientResponse<MonthlyActiveUserReportResponse,com.inversoft.error.Errors> |
retrieveMonthlyActiveReport(UUID applicationId,
long start,
long end)
Retrieves the monthly active user report between the two instants.
|
com.inversoft.rest.ClientResponse<OAuthConfigurationResponse,com.inversoft.error.Errors> |
retrieveOauthConfiguration(UUID applicationId)
Retrieves the Oauth2 configuration for the application for the given Application Id.
|
com.inversoft.rest.ClientResponse<OpenIdConfiguration,Void> |
retrieveOpenIdConfiguration()
Returns the well known OpenID Configuration JSON document
|
com.inversoft.rest.ClientResponse<PasswordValidationRulesResponse,Void> |
retrievePasswordValidationRules()
Retrieves the password validation rules for a specific tenant.
|
com.inversoft.rest.ClientResponse<PasswordValidationRulesResponse,Void> |
retrievePasswordValidationRulesWithTenantId(UUID tenantId)
Retrieves the password validation rules for a specific tenant.
|
com.inversoft.rest.ClientResponse<PendingResponse,com.inversoft.error.Errors> |
retrievePendingChildren(String parentEmail)
Retrieves all of the children for the given parent email address.
|
com.inversoft.rest.ClientResponse<ReactorResponse,Void> |
retrieveReactorStatus()
Retrieves the FusionAuth Reactor status.
|
com.inversoft.rest.ClientResponse<RecentLoginResponse,com.inversoft.error.Errors> |
retrieveRecentLogins(int offset,
Integer limit)
Retrieves the last number of login records.
|
com.inversoft.rest.ClientResponse<RefreshTokenResponse,com.inversoft.error.Errors> |
retrieveRefreshTokenById(UUID userId)
Retrieves a single refresh token by unique Id.
|
com.inversoft.rest.ClientResponse<RefreshTokenResponse,com.inversoft.error.Errors> |
retrieveRefreshTokens(UUID userId)
Retrieves the refresh tokens that belong to the user with the given Id.
|
com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> |
retrieveRegistration(UUID userId,
UUID applicationId)
Retrieves the user registration for the user with the given id and the given application id.
|
com.inversoft.rest.ClientResponse<RegistrationReportResponse,com.inversoft.error.Errors> |
retrieveRegistrationReport(UUID applicationId,
long start,
long end)
Retrieves the registration report between the two instants.
|
com.inversoft.rest.ClientResponse<SystemConfigurationResponse,Void> |
retrieveSystemConfiguration()
Retrieves the system configuration.
|
com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> |
retrieveTenant(UUID tenantId)
Retrieves the tenant for the given Id.
|
com.inversoft.rest.ClientResponse<TenantResponse,Void> |
retrieveTenants()
Retrieves all of the tenants.
|
com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> |
retrieveTheme(UUID themeId)
Retrieves the theme for the given Id.
|
com.inversoft.rest.ClientResponse<ThemeResponse,Void> |
retrieveThemes()
Retrieves all of the themes.
|
com.inversoft.rest.ClientResponse<TotalsReportResponse,Void> |
retrieveTotalReport()
Retrieves the totals report.
|
com.inversoft.rest.ClientResponse<TwoFactorRecoveryCodeResponse,com.inversoft.error.Errors> |
retrieveTwoFactorRecoveryCodes(UUID userId)
Retrieve two-factor recovery codes for a user.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUser(UUID userId)
Retrieves the user for the given Id.
|
com.inversoft.rest.ClientResponse<UserActionResponse,Void> |
retrieveUserAction(UUID userActionId)
Retrieves the user action for the given Id.
|
com.inversoft.rest.ClientResponse<UserActionReasonResponse,Void> |
retrieveUserActionReason(UUID userActionReasonId)
Retrieves the user action reason for the given Id.
|
com.inversoft.rest.ClientResponse<UserActionReasonResponse,Void> |
retrieveUserActionReasons()
Retrieves all the user action reasons.
|
com.inversoft.rest.ClientResponse<UserActionResponse,Void> |
retrieveUserActions()
Retrieves all of the user actions.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUserByChangePasswordId(String changePasswordId)
Retrieves the user by a change password Id.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUserByEmail(String email)
Retrieves the user for the given email.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUserByLoginId(String loginId)
Retrieves the user for the loginId.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUserByUsername(String username)
Retrieves the user for the given username.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUserByVerificationId(String verificationId)
Retrieves the user by a verificationId.
|
com.inversoft.rest.ClientResponse<UserCommentResponse,com.inversoft.error.Errors> |
retrieveUserComments(UUID userId)
Retrieves all of the comments for the user with the given Id.
|
com.inversoft.rest.ClientResponse<UserConsentResponse,Void> |
retrieveUserConsent(UUID userConsentId)
Retrieve a single User consent by Id.
|
com.inversoft.rest.ClientResponse<UserConsentResponse,Void> |
retrieveUserConsents(UUID userId)
Retrieves all of the consents for a User.
|
com.inversoft.rest.ClientResponse<UserResponse,OAuthError> |
retrieveUserInfoFromAccessToken(String encodedJWT)
Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
|
com.inversoft.rest.ClientResponse<LoginReportResponse,com.inversoft.error.Errors> |
retrieveUserLoginReport(UUID applicationId,
UUID userId,
long start,
long end)
Retrieves the login report between the two instants for a particular user by Id.
|
com.inversoft.rest.ClientResponse<LoginReportResponse,com.inversoft.error.Errors> |
retrieveUserLoginReportByLoginId(UUID applicationId,
String loginId,
long start,
long end)
Retrieves the login report between the two instants for a particular user by login Id.
|
com.inversoft.rest.ClientResponse<RecentLoginResponse,com.inversoft.error.Errors> |
retrieveUserRecentLogins(UUID userId,
int offset,
Integer limit)
Retrieves the last number of login records for a user.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
retrieveUserUsingJWT(String encodedJWT)
Retrieves the user for the given Id.
|
com.inversoft.rest.ClientResponse<VersionResponse,com.inversoft.error.Errors> |
retrieveVersion()
Retrieves the FusionAuth version string.
|
com.inversoft.rest.ClientResponse<WebhookResponse,Void> |
retrieveWebhook(UUID webhookId)
Retrieves the webhook for the given Id.
|
com.inversoft.rest.ClientResponse<WebhookResponse,Void> |
retrieveWebhooks()
Retrieves all the webhooks.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
revokeRefreshToken(String token,
UUID userId,
UUID applicationId)
Revokes refresh tokens.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
revokeRefreshTokenById(UUID tokenId)
Revokes a single refresh token by the unique Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
revokeRefreshTokenByToken(String token)
Revokes a single refresh token by using the actual refresh token value.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
revokeRefreshTokensByApplicationId(UUID applicationId)
Revoke all refresh tokens that belong to an application by applicationId.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
revokeRefreshTokensByUserId(UUID userId)
Revoke all refresh tokens that belong to a user by user Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
revokeRefreshTokensByUserIdForApplication(UUID userId,
UUID applicationId)
Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
|
com.inversoft.rest.ClientResponse<Void,Void> |
revokeUserConsent(UUID userConsentId)
Revokes a single User consent by Id.
|
com.inversoft.rest.ClientResponse<AuditLogSearchResponse,Void> |
searchAuditLogs(AuditLogSearchRequest request)
Searches the audit logs with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<EntitySearchResponse,com.inversoft.error.Errors> |
searchEntities(EntitySearchRequest request)
Searches entities with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<EntitySearchResponse,com.inversoft.error.Errors> |
searchEntitiesByIds(Collection<UUID> ids)
Retrieves the entities for the given ids.
|
com.inversoft.rest.ClientResponse<EntityGrantSearchResponse,com.inversoft.error.Errors> |
searchEntityGrants(EntityGrantSearchRequest request)
Searches Entity Grants with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<EntityTypeSearchResponse,Void> |
searchEntityTypes(EntityTypeSearchRequest request)
Searches the entity types with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<EventLogSearchResponse,Void> |
searchEventLogs(EventLogSearchRequest request)
Searches the event logs with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<LoginRecordSearchResponse,Void> |
searchLoginRecords(LoginRecordSearchRequest request)
Searches the login records with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> |
searchUsers(Collection<UUID> ids)
Deprecated.
This method has been renamed to searchUsersByIds, use that method instead.
|
com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> |
searchUsersByIds(Collection<UUID> ids)
Retrieves the users for the given ids.
|
com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> |
searchUsersByQuery(SearchRequest request)
Retrieves the users for the given search criteria and pagination.
|
com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> |
searchUsersByQueryString(SearchRequest request)
Deprecated.
This method has been renamed to searchUsersByQuery, use that method instead.
|
com.inversoft.rest.ClientResponse<SendResponse,com.inversoft.error.Errors> |
sendEmail(UUID emailTemplateId,
SendRequest request)
Send an email using an email template id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
sendFamilyRequestEmail(FamilyEmailRequest request)
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.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
sendPasswordlessCode(PasswordlessSendRequest request)
Send a passwordless authentication code in an email to complete login.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
sendTwoFactorCode(TwoFactorSendRequest request)
Deprecated.
This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
sendTwoFactorCodeForEnableDisable(TwoFactorSendRequest request)
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
sendTwoFactorCodeForLogin(String twoFactorId)
Deprecated.
This method has been renamed to sendTwoFactorCodeForLoginUsingMethod, use that method instead.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
sendTwoFactorCodeForLoginUsingMethod(String twoFactorId,
TwoFactorSendRequest request)
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
|
FusionAuthClient |
setTenantId(UUID tenantId)
Creates a new copy of this client with the provided tenant Id.
|
protected <T,U> com.inversoft.rest.RESTClient<T,U> |
start(Class<T> type,
Class<U> errorType) |
protected <T,U> com.inversoft.rest.RESTClient<T,U> |
startAnonymous(Class<T> type,
Class<U> errorType) |
com.inversoft.rest.ClientResponse<IdentityProviderStartLoginResponse,com.inversoft.error.Errors> |
startIdentityProviderLogin(IdentityProviderStartLoginRequest request)
Begins a login request for a 3rd party login that requires user interaction such as HYPR.
|
com.inversoft.rest.ClientResponse<PasswordlessStartResponse,com.inversoft.error.Errors> |
startPasswordlessLogin(PasswordlessStartRequest request)
Start a passwordless login request by generating a passwordless code.
|
com.inversoft.rest.ClientResponse<TwoFactorStartResponse,com.inversoft.error.Errors> |
startTwoFactorLogin(TwoFactorStartRequest request)
Start a Two-Factor login request by generating a two-factor identifier.
|
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
twoFactorLogin(TwoFactorLoginRequest request)
Complete login using a 2FA challenge
|
com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> |
updateAPIKey(UUID apiKeyId,
APIKeyRequest request)
Updates an API key by given id
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
updateApplication(UUID applicationId,
ApplicationRequest request)
Updates the application with the given Id.
|
com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> |
updateApplicationRole(UUID applicationId,
UUID roleId,
ApplicationRequest request)
Updates the application role with the given id for the application.
|
com.inversoft.rest.ClientResponse<ConnectorResponse,com.inversoft.error.Errors> |
updateConnector(UUID connectorId,
ConnectorRequest request)
Updates the connector with the given Id.
|
com.inversoft.rest.ClientResponse<ConsentResponse,com.inversoft.error.Errors> |
updateConsent(UUID consentId,
ConsentRequest request)
Updates the consent with the given Id.
|
com.inversoft.rest.ClientResponse<EmailTemplateResponse,com.inversoft.error.Errors> |
updateEmailTemplate(UUID emailTemplateId,
EmailTemplateRequest request)
Updates the email template with the given Id.
|
com.inversoft.rest.ClientResponse<EntityResponse,com.inversoft.error.Errors> |
updateEntity(UUID entityId,
EntityRequest request)
Updates the Entity with the given Id.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
updateEntityType(UUID entityTypeId,
EntityTypeRequest request)
Updates the Entity Type with the given Id.
|
com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> |
updateEntityTypePermission(UUID entityTypeId,
UUID permissionId,
EntityTypeRequest request)
Updates the permission with the given id for the entity type.
|
com.inversoft.rest.ClientResponse<FormResponse,com.inversoft.error.Errors> |
updateForm(UUID formId,
FormRequest request)
Updates the form with the given Id.
|
com.inversoft.rest.ClientResponse<FormFieldResponse,com.inversoft.error.Errors> |
updateFormField(UUID fieldId,
FormFieldRequest request)
Updates the form field with the given Id.
|
com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> |
updateGroup(UUID groupId,
GroupRequest request)
Updates the group with the given Id.
|
com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> |
updateIdentityProvider(UUID identityProviderId,
IdentityProviderRequest request)
Updates the identity provider with the given Id.
|
com.inversoft.rest.ClientResponse<IntegrationResponse,com.inversoft.error.Errors> |
updateIntegrations(IntegrationRequest request)
Updates the available integrations.
|
com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> |
updateKey(UUID keyId,
KeyRequest request)
Updates the key with the given Id.
|
com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> |
updateLambda(UUID lambdaId,
LambdaRequest request)
Updates the lambda with the given Id.
|
com.inversoft.rest.ClientResponse<MessageTemplateResponse,com.inversoft.error.Errors> |
updateMessageTemplate(UUID messageTemplateId,
MessageTemplateRequest request)
Updates the message template with the given Id.
|
com.inversoft.rest.ClientResponse<MessengerResponse,com.inversoft.error.Errors> |
updateMessenger(UUID messengerId,
MessengerRequest request)
Updates the messenger with the given Id.
|
com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> |
updateRegistration(UUID userId,
RegistrationRequest request)
Updates the registration for the user with the given id and the application defined in the request.
|
com.inversoft.rest.ClientResponse<SystemConfigurationResponse,com.inversoft.error.Errors> |
updateSystemConfiguration(SystemConfigurationRequest request)
Updates the system configuration.
|
com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> |
updateTenant(UUID tenantId,
TenantRequest request)
Updates the tenant with the given Id.
|
com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> |
updateTheme(UUID themeId,
ThemeRequest request)
Updates the theme with the given Id.
|
com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> |
updateUser(UUID userId,
UserRequest request)
Updates the user with the given Id.
|
com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> |
updateUserAction(UUID userActionId,
UserActionRequest request)
Updates the user action with the given Id.
|
com.inversoft.rest.ClientResponse<UserActionReasonResponse,com.inversoft.error.Errors> |
updateUserActionReason(UUID userActionReasonId,
UserActionReasonRequest request)
Updates the user action reason with the given Id.
|
com.inversoft.rest.ClientResponse<UserConsentResponse,com.inversoft.error.Errors> |
updateUserConsent(UUID userConsentId,
UserConsentRequest request)
Updates a single User consent by Id.
|
com.inversoft.rest.ClientResponse<WebhookResponse,com.inversoft.error.Errors> |
updateWebhook(UUID webhookId,
WebhookRequest request)
Updates the webhook with the given Id.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
upsertEntityGrant(UUID entityId,
EntityGrantRequest request)
Creates or updates an Entity Grant.
|
com.inversoft.rest.ClientResponse<Void,Void> |
validateDevice(String user_code,
String client_id)
Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant.
|
com.inversoft.rest.ClientResponse<ValidateResponse,Void> |
validateJWT(String encodedJWT)
Validates the provided JWT (encoded JWT string) to ensure the token is valid.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
verifyEmail(String verificationId)
Deprecated.
This method has been renamed to verifyEmailAddress and changed to take a JSON request body, use that method instead.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
verifyEmailAddress(VerifyEmailRequest request)
Confirms a user's email address.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
verifyRegistration(String verificationId)
Deprecated.
This method has been renamed to verifyUserRegistration and changed to take a JSON request body, use that method instead.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
verifyUserRegistration(VerifyRegistrationRequest request)
Confirms a user's registration.
|
public static String TENANT_ID_HEADER
public static final com.fasterxml.jackson.databind.ObjectMapper objectMapper
public int connectTimeout
public int readTimeout
public FusionAuthClient(String apiKey, String baseURL, int connectTimeout, int readTimeout)
public FusionAuthClient setTenantId(UUID tenantId)
When only one tenant is configured, or you have you have not configured tenants, setting the tenant is not necessary.
tenantId
- The tenant Idpublic com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> actionUser(ActionRequest request)
request
- 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).public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> activateReactor(ReactorRequest request)
request
- An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).public com.inversoft.rest.ClientResponse<FamilyResponse,com.inversoft.error.Errors> addUserToFamily(UUID familyId, FamilyRequest request)
familyId
- The id of the family.request
- The request object that contains all of the information used to determine which user to add to the family.public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> cancelAction(UUID actionId, ActionRequest request)
actionId
- The action id of the action to cancel.request
- The action request that contains the information about the cancellation.public com.inversoft.rest.ClientResponse<ChangePasswordResponse,com.inversoft.error.Errors> changePassword(String changePasswordId, ChangePasswordRequest request)
changePasswordId
- The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.request
- The change password request that contains all of the information used to change the password.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> changePasswordByIdentity(ChangePasswordRequest request)
request
- The change password request that contains all of the information used to change the password.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> commentOnUser(UserCommentRequest request)
request
- The request object that contains all of the information used to create the user comment.public com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> createAPIKey(UUID keyId, APIKeyRequest request)
keyId
- (Optional) The unique Id of the API key. If not provided a secure random Id will be generated.request
- The request object that contains all of the information needed to create the APIKey.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> createApplication(UUID applicationId, ApplicationRequest request)
applicationId
- (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the application.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> createApplicationRole(UUID applicationId, UUID roleId, ApplicationRequest request)
applicationId
- The Id of the application to create the role on.roleId
- (Optional) The Id of the role. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the application role.public com.inversoft.rest.ClientResponse<AuditLogResponse,com.inversoft.error.Errors> createAuditLog(AuditLogRequest request)
request
- The request object that contains all of the information used to create the audit log entry.public com.inversoft.rest.ClientResponse<ConnectorResponse,com.inversoft.error.Errors> createConnector(UUID connectorId, ConnectorRequest request)
connectorId
- (Optional) The Id for the connector. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the connector.public com.inversoft.rest.ClientResponse<ConsentResponse,com.inversoft.error.Errors> createConsent(UUID consentId, ConsentRequest request)
consentId
- (Optional) The Id for the consent. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the consent.public com.inversoft.rest.ClientResponse<EmailTemplateResponse,com.inversoft.error.Errors> createEmailTemplate(UUID emailTemplateId, EmailTemplateRequest request)
emailTemplateId
- (Optional) The Id for the template. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the email template.public com.inversoft.rest.ClientResponse<EntityResponse,com.inversoft.error.Errors> createEntity(UUID entityId, EntityRequest request)
entityId
- (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the Entity.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> createEntityType(UUID entityTypeId, EntityTypeRequest request)
entityTypeId
- (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the Entity Type.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> createEntityTypePermission(UUID entityTypeId, UUID permissionId, EntityTypeRequest request)
entityTypeId
- The Id of the entity type to create the permission on.permissionId
- (Optional) The Id of the permission. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the permission.public com.inversoft.rest.ClientResponse<FamilyResponse,com.inversoft.error.Errors> createFamily(UUID familyId, FamilyRequest request)
familyId
- (Optional) The id for the family. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the family.public com.inversoft.rest.ClientResponse<FormResponse,com.inversoft.error.Errors> createForm(UUID formId, FormRequest request)
formId
- (Optional) The Id for the form. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the form.public com.inversoft.rest.ClientResponse<FormFieldResponse,com.inversoft.error.Errors> createFormField(UUID fieldId, FormFieldRequest request)
fieldId
- (Optional) The Id for the form field. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the form field.public com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> createGroup(UUID groupId, GroupRequest request)
groupId
- (Optional) The Id for the group. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the group.public com.inversoft.rest.ClientResponse<MemberResponse,com.inversoft.error.Errors> createGroupMembers(MemberRequest request)
request
- The request object that contains all of the information used to create the group member(s).public com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> createIdentityProvider(UUID identityProviderId, IdentityProviderRequest request)
identityProviderId
- (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the identity provider.public com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> createLambda(UUID lambdaId, LambdaRequest request)
lambdaId
- (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the lambda.public com.inversoft.rest.ClientResponse<MessageTemplateResponse,com.inversoft.error.Errors> createMessageTemplate(UUID messageTemplateId, MessageTemplateRequest request)
messageTemplateId
- (Optional) The Id for the template. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the message template.public com.inversoft.rest.ClientResponse<MessengerResponse,com.inversoft.error.Errors> createMessenger(UUID messengerId, MessengerRequest request)
messengerId
- (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the messenger.public com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> createTenant(UUID tenantId, TenantRequest request)
tenantId
- (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the tenant.public com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> createTheme(UUID themeId, ThemeRequest request)
themeId
- (Optional) The Id for the theme. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the theme.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> createUser(UUID userId, UserRequest request)
userId
- (Optional) The Id for the user. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the user.public com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> createUserAction(UUID userActionId, UserActionRequest request)
userActionId
- (Optional) The Id for the user action. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the user action.public com.inversoft.rest.ClientResponse<UserActionReasonResponse,com.inversoft.error.Errors> createUserActionReason(UUID userActionReasonId, UserActionReasonRequest request)
userActionReasonId
- (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the user action reason.public com.inversoft.rest.ClientResponse<UserConsentResponse,com.inversoft.error.Errors> createUserConsent(UUID userConsentId, UserConsentRequest request)
userConsentId
- (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.request
- The request that contains the user consent information.public com.inversoft.rest.ClientResponse<WebhookResponse,com.inversoft.error.Errors> createWebhook(UUID webhookId, WebhookRequest request)
webhookId
- (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the webhook.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deactivateApplication(UUID applicationId)
applicationId
- The Id of the application to deactivate.public com.inversoft.rest.ClientResponse<Void,Void> deactivateReactor()
public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deactivateUser(UUID userId)
userId
- The Id of the user to deactivate.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deactivateUserAction(UUID userActionId)
userActionId
- The Id of the user action to deactivate.@Deprecated public com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> deactivateUsers(Collection<UUID> userIds)
userIds
- The ids of the users to deactivate.public com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> deactivateUsersByIds(Collection<UUID> userIds)
userIds
- The ids of the users to deactivate.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteAPIKey(UUID keyId)
keyId
- The Id of the authentication API key to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteApplication(UUID applicationId)
applicationId
- The Id of the application to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteApplicationRole(UUID applicationId, UUID roleId)
applicationId
- The Id of the application to deactivate.roleId
- The Id of the role to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteConnector(UUID connectorId)
connectorId
- The Id of the connector to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteConsent(UUID consentId)
consentId
- The Id of the consent to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteEmailTemplate(UUID emailTemplateId)
emailTemplateId
- The Id of the email template to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteEntity(UUID entityId)
entityId
- The Id of the Entity to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteEntityGrant(UUID entityId, UUID recipientEntityId, UUID userId)
entityId
- The Id of the Entity that the Entity Grant is being deleted for.recipientEntityId
- (Optional) The Id of the Entity that the Entity Grant is for.userId
- (Optional) The Id of the User that the Entity Grant is for.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteEntityType(UUID entityTypeId)
entityTypeId
- The Id of the Entity Type to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteEntityTypePermission(UUID entityTypeId, UUID permissionId)
entityTypeId
- The Id of the entityType the the permission belongs to.permissionId
- The Id of the permission to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteForm(UUID formId)
formId
- The Id of the form to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteFormField(UUID fieldId)
fieldId
- The Id of the form field to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteGroup(UUID groupId)
groupId
- The Id of the group to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteGroupMembers(MemberDeleteRequest request)
request
- The member request that contains all of the information used to remove members to the group.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteIdentityProvider(UUID identityProviderId)
identityProviderId
- The Id of the identity provider to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteKey(UUID keyId)
keyId
- The Id of the key to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteLambda(UUID lambdaId)
lambdaId
- The Id of the lambda to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteMessageTemplate(UUID messageTemplateId)
messageTemplateId
- The Id of the message template to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteMessenger(UUID messengerId)
messengerId
- The Id of the messenger to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteRegistration(UUID userId, UUID applicationId)
userId
- The Id of the user whose registration is being deleted.applicationId
- The Id of the application to remove the registration for.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteTenant(UUID tenantId)
tenantId
- The Id of the tenant to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteTenantAsync(UUID tenantId)
tenantId
- The Id of the tenant to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteTheme(UUID themeId)
themeId
- The Id of the theme to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteUser(UUID userId)
userId
- The Id of the user to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteUserAction(UUID userActionId)
userActionId
- The Id of the user action to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteUserActionReason(UUID userActionReasonId)
userActionReasonId
- The Id of the user action reason to delete.@Deprecated public com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> deleteUsers(UserDeleteRequest request)
request
- The UserDeleteRequest.public com.inversoft.rest.ClientResponse<UserDeleteResponse,com.inversoft.error.Errors> deleteUsersByQuery(UserDeleteRequest request)
request
- The UserDeleteRequest.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteWebhook(UUID webhookId)
webhookId
- The Id of the webhook to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> disableTwoFactor(UUID userId, String methodId, String code)
userId
- The Id of the User for which you're disabling Two Factor authentication.methodId
- The two-factor method identifier you wish to disablecode
- The Two Factor code used verify the the caller knows the Two Factor secret.public com.inversoft.rest.ClientResponse<TwoFactorResponse,com.inversoft.error.Errors> enableTwoFactor(UUID userId, TwoFactorRequest request)
userId
- The Id of the user to enable Two Factor authentication.request
- The two factor enable request information.public com.inversoft.rest.ClientResponse<AccessToken,OAuthError> exchangeOAuthCodeForAccessToken(String code, String client_id, String client_secret, String redirect_uri)
code
- The authorization code returned on the /oauth2/authorize response.client_id
- The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate.client_secret
- (Optional) The client secret. This value will be required if client authentication is enabled.redirect_uri
- The URI to redirect to upon a successful request.public com.inversoft.rest.ClientResponse<AccessToken,OAuthError> exchangeOAuthCodeForAccessTokenUsingPKCE(String code, String client_id, String client_secret, String redirect_uri, String code_verifier)
code
- The authorization code returned on the /oauth2/authorize response.client_id
- (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.client_secret
- (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.redirect_uri
- The URI to redirect to upon a successful request.code_verifier
- The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.public com.inversoft.rest.ClientResponse<AccessToken,OAuthError> exchangeRefreshTokenForAccessToken(String refresh_token, String client_id, String client_secret, String scope, String user_code)
refresh_token
- The refresh token that you would like to use to exchange for an access token.client_id
- (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.client_secret
- (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.scope
- (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.user_code
- (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.public com.inversoft.rest.ClientResponse<JWTRefreshResponse,com.inversoft.error.Errors> exchangeRefreshTokenForJWT(RefreshRequest request)
request
- The refresh request.public com.inversoft.rest.ClientResponse<AccessToken,OAuthError> exchangeUserCredentialsForAccessToken(String username, String password, String client_id, String client_secret, String scope, String user_code)
username
- The login identifier of the user. The login identifier can be either the email or the username.password
- The user’s password.client_id
- (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.client_secret
- (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.scope
- (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.user_code
- (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.public com.inversoft.rest.ClientResponse<ForgotPasswordResponse,com.inversoft.error.Errors> forgotPassword(ForgotPasswordRequest request)
request
- The request that contains the information about the user so that they can be emailed.public com.inversoft.rest.ClientResponse<VerifyEmailResponse,Void> generateEmailVerificationId(String email)
email
- The email address of the user that needs a new verification email.public com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> generateKey(UUID keyId, KeyRequest request)
keyId
- (Optional) The Id for the key. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the key.public com.inversoft.rest.ClientResponse<VerifyRegistrationResponse,Void> generateRegistrationVerificationId(String email, UUID applicationId)
email
- The email address of the user that needs a new verification email.applicationId
- The Id of the application to be verified.public com.inversoft.rest.ClientResponse<TwoFactorRecoveryCodeResponse,com.inversoft.error.Errors> generateTwoFactorRecoveryCodes(UUID userId)
userId
- The Id of the user to generate new Two Factor recovery codes.public com.inversoft.rest.ClientResponse<SecretResponse,Void> generateTwoFactorSecret()
public com.inversoft.rest.ClientResponse<SecretResponse,Void> generateTwoFactorSecretUsingJWT(String encodedJWT)
encodedJWT
- The encoded JWT (access token).public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> identityProviderLogin(IdentityProviderLoginRequest request)
request
- The third-party login request that contains information from the third-party login
providers that FusionAuth uses to reconcile the user's account.public com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> importKey(UUID keyId, KeyRequest request)
keyId
- (Optional) The Id for the key. If not provided a secure random UUID will be generated.request
- The request object that contains all of the information used to create the key.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> importRefreshTokens(RefreshTokenImportRequest request)
request
- The request that contains all of the information about all of the refresh tokens to import.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> importUsers(ImportRequest request)
request
- The request that contains all of the information about all of the users to import.public com.inversoft.rest.ClientResponse<IntrospectResponse,OAuthError> introspectAccessToken(String client_id, String token)
client_id
- The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.token
- The access token returned by this OAuth provider as the result of a successful authentication.public com.inversoft.rest.ClientResponse<IssueResponse,com.inversoft.error.Errors> issueJWT(UUID applicationId, String encodedJWT, String refreshToken)
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.
applicationId
- The Application Id for which you are requesting a new access token be issued.encodedJWT
- The encoded JWT (access token).refreshToken
- (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.
public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> login(LoginRequest request)
Application.loginConfiguration.requireAuthentication
.request
- The login request that contains the user credentials used to log them in.public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> loginPing(UUID userId, UUID applicationId, String callerIPAddress)
userId
- The Id of the user that was logged in.applicationId
- The Id of the application that they logged into.callerIPAddress
- (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.public com.inversoft.rest.ClientResponse<Void,Void> logout(boolean global, String refreshToken)
global
- When this value is set to true all of the refresh tokens issued to the owner of the
provided token will be revoked.refreshToken
- (Optional) The refresh_token as a request parameter instead of coming in via a cookie.
If provided this takes precedence over the cookie.public com.inversoft.rest.ClientResponse<LookupResponse,Void> lookupIdentityProvider(String domain)
domain
- The domain or email address to lookup.public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> modifyAction(UUID actionId, ActionRequest request)
actionId
- The Id of the action to modify. This is technically the user action log id.request
- The request that contains all of the information about the modification.public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> passwordlessLogin(PasswordlessLoginRequest request)
request
- The passwordless login request that contains all of the information used to complete login.public com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> patchAPIKey(UUID keyId, APIKeyRequest request)
keyId
- The Id of the authentication key. If not provided a secure random api key will be generated.request
- The request object that contains all of the information needed to create the APIKey.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> patchApplication(UUID applicationId, Map<String,Object> request)
applicationId
- The Id of the application to update.request
- The request that contains just the new application information.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> patchApplicationRole(UUID applicationId, UUID roleId, Map<String,Object> request)
applicationId
- The Id of the application that the role belongs to.roleId
- The Id of the role to update.request
- The request that contains just the new role information.public com.inversoft.rest.ClientResponse<ConnectorResponse,com.inversoft.error.Errors> patchConnector(UUID connectorId, Map<String,Object> request)
connectorId
- The Id of the connector to update.request
- The request that contains just the new connector information.public com.inversoft.rest.ClientResponse<ConsentResponse,com.inversoft.error.Errors> patchConsent(UUID consentId, Map<String,Object> request)
consentId
- The Id of the consent to update.request
- The request that contains just the new consent information.public com.inversoft.rest.ClientResponse<EmailTemplateResponse,com.inversoft.error.Errors> patchEmailTemplate(UUID emailTemplateId, Map<String,Object> request)
emailTemplateId
- The Id of the email template to update.request
- The request that contains just the new email template information.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> patchEntityType(UUID entityTypeId, Map<String,Object> request)
entityTypeId
- The Id of the Entity Type to update.request
- The request that contains just the new Entity Type information.public com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> patchGroup(UUID groupId, Map<String,Object> request)
groupId
- The Id of the group to update.request
- The request that contains just the new group information.public com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> patchIdentityProvider(UUID identityProviderId, Map<String,Object> request)
identityProviderId
- The Id of the identity provider to update.request
- The request object that contains just the updated identity provider information.public com.inversoft.rest.ClientResponse<IntegrationResponse,com.inversoft.error.Errors> patchIntegrations(Map<String,Object> request)
request
- The request that contains just the new integration information.public com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> patchLambda(UUID lambdaId, Map<String,Object> request)
lambdaId
- The Id of the lambda to update.request
- The request that contains just the new lambda information.public com.inversoft.rest.ClientResponse<MessageTemplateResponse,com.inversoft.error.Errors> patchMessageTemplate(UUID messageTemplateId, Map<String,Object> request)
messageTemplateId
- The Id of the message template to update.request
- The request that contains just the new message template information.public com.inversoft.rest.ClientResponse<MessengerResponse,com.inversoft.error.Errors> patchMessenger(UUID messengerId, Map<String,Object> request)
messengerId
- The Id of the messenger to update.request
- The request that contains just the new messenger information.public com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> patchRegistration(UUID userId, Map<String,Object> request)
userId
- The Id of the user whose registration is going to be updated.request
- The request that contains just the new registration information.public com.inversoft.rest.ClientResponse<SystemConfigurationResponse,com.inversoft.error.Errors> patchSystemConfiguration(Map<String,Object> request)
request
- The request that contains just the new system configuration information.public com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> patchTenant(UUID tenantId, Map<String,Object> request)
tenantId
- The Id of the tenant to update.request
- The request that contains just the new tenant information.public com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> patchTheme(UUID themeId, Map<String,Object> request)
themeId
- The Id of the theme to update.request
- The request that contains just the new theme information.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> patchUser(UUID userId, Map<String,Object> request)
userId
- The Id of the user to update.request
- The request that contains just the new user information.public com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> patchUserAction(UUID userActionId, Map<String,Object> request)
userActionId
- The Id of the user action to update.request
- The request that contains just the new user action information.public com.inversoft.rest.ClientResponse<UserActionReasonResponse,com.inversoft.error.Errors> patchUserActionReason(UUID userActionReasonId, Map<String,Object> request)
userActionReasonId
- The Id of the user action reason to update.request
- The request that contains just the new user action reason information.public com.inversoft.rest.ClientResponse<UserConsentResponse,com.inversoft.error.Errors> patchUserConsent(UUID userConsentId, Map<String,Object> request)
userConsentId
- The User Consent Idrequest
- The request that contains just the new user consent information.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> reactivateApplication(UUID applicationId)
applicationId
- The Id of the application to reactivate.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> reactivateUser(UUID userId)
userId
- The Id of the user to reactivate.public com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> reactivateUserAction(UUID userActionId)
userActionId
- The Id of the user action to reactivate.public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> reconcileJWT(IdentityProviderLoginRequest request)
request
- The reconcile request that contains the data to reconcile the User.public com.inversoft.rest.ClientResponse<Void,Void> refreshEntitySearchIndex()
public com.inversoft.rest.ClientResponse<Void,Void> refreshUserSearchIndex()
public com.inversoft.rest.ClientResponse<Void,Void> regenerateReactorKeys()
public com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> register(UUID userId, RegistrationRequest request)
userId
- (Optional) The Id of the user being registered for the application and optionally created.request
- The request that optionally contains the User and must contain the UserRegistration.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> removeUserFromFamily(UUID familyId, UUID userId)
familyId
- The id of the family to remove the user from.userId
- The id of the user to remove from the family.public com.inversoft.rest.ClientResponse<VerifyEmailResponse,com.inversoft.error.Errors> resendEmailVerification(String email)
email
- The email address of the user that needs a new verification email.public com.inversoft.rest.ClientResponse<VerifyEmailResponse,com.inversoft.error.Errors> resendEmailVerificationWithApplicationTemplate(UUID applicationId, String email)
applicationId
- The unique Application Id to used to resolve an application specific email template.email
- The email address of the user that needs a new verification email.public com.inversoft.rest.ClientResponse<VerifyRegistrationResponse,com.inversoft.error.Errors> resendRegistrationVerification(String email, UUID applicationId)
email
- The email address of the user that needs a new verification email.applicationId
- The Id of the application to be verified.public com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> retrieveAPIKey(UUID keyId)
keyId
- The Id of the API key to retrieve.public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> retrieveAction(UUID actionId)
actionId
- The Id of the action to retrieve.public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> retrieveActions(UUID userId)
userId
- The Id of the user to fetch the actions for.public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> retrieveActionsPreventingLogin(UUID userId)
userId
- The Id of the user to fetch the actions for.public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> retrieveActiveActions(UUID userId)
userId
- The Id of the user to fetch the actions for.public com.inversoft.rest.ClientResponse<ApplicationResponse,Void> retrieveApplication(UUID applicationId)
applicationId
- (Optional) The application id.public com.inversoft.rest.ClientResponse<ApplicationResponse,Void> retrieveApplications()
public com.inversoft.rest.ClientResponse<AuditLogResponse,com.inversoft.error.Errors> retrieveAuditLog(Integer auditLogId)
auditLogId
- The Id of the audit log to retrieve.public com.inversoft.rest.ClientResponse<ConnectorResponse,Void> retrieveConnector(UUID connectorId)
connectorId
- The Id of the connector.public com.inversoft.rest.ClientResponse<ConnectorResponse,Void> retrieveConnectors()
public com.inversoft.rest.ClientResponse<ConsentResponse,Void> retrieveConsent(UUID consentId)
consentId
- The Id of the consent.public com.inversoft.rest.ClientResponse<ConsentResponse,Void> retrieveConsents()
public com.inversoft.rest.ClientResponse<DailyActiveUserReportResponse,com.inversoft.error.Errors> retrieveDailyActiveReport(UUID applicationId, long start, long end)
applicationId
- (Optional) The application id.start
- The start instant as UTC milliseconds since Epoch.end
- The end instant as UTC milliseconds since Epoch.public com.inversoft.rest.ClientResponse<EmailTemplateResponse,Void> retrieveEmailTemplate(UUID emailTemplateId)
emailTemplateId
- (Optional) The Id of the email template.public com.inversoft.rest.ClientResponse<PreviewResponse,com.inversoft.error.Errors> retrieveEmailTemplatePreview(PreviewRequest request)
request
- The request that contains the email template and optionally a locale to render it in.public com.inversoft.rest.ClientResponse<EmailTemplateResponse,Void> retrieveEmailTemplates()
public com.inversoft.rest.ClientResponse<EntityResponse,com.inversoft.error.Errors> retrieveEntity(UUID entityId)
entityId
- The Id of the Entity.public com.inversoft.rest.ClientResponse<EntityGrantResponse,com.inversoft.error.Errors> retrieveEntityGrant(UUID entityId, UUID recipientEntityId, UUID userId)
entityId
- The Id of the Entity.recipientEntityId
- (Optional) The Id of the Entity that the Entity Grant is for.userId
- (Optional) The Id of the User that the Entity Grant is for.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> retrieveEntityType(UUID entityTypeId)
entityTypeId
- The Id of the Entity Type.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> retrieveEntityTypes()
public com.inversoft.rest.ClientResponse<EventLogResponse,com.inversoft.error.Errors> retrieveEventLog(Integer eventLogId)
eventLogId
- The Id of the event log to retrieve.public com.inversoft.rest.ClientResponse<FamilyResponse,Void> retrieveFamilies(UUID userId)
userId
- The User's idpublic com.inversoft.rest.ClientResponse<FamilyResponse,Void> retrieveFamilyMembersByFamilyId(UUID familyId)
familyId
- The unique Id of the Family.public com.inversoft.rest.ClientResponse<FormResponse,Void> retrieveForm(UUID formId)
formId
- The Id of the form.public com.inversoft.rest.ClientResponse<FormFieldResponse,Void> retrieveFormField(UUID fieldId)
fieldId
- The Id of the form field.public com.inversoft.rest.ClientResponse<FormFieldResponse,Void> retrieveFormFields()
public com.inversoft.rest.ClientResponse<FormResponse,Void> retrieveForms()
public com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> retrieveGroup(UUID groupId)
groupId
- The Id of the group.public com.inversoft.rest.ClientResponse<GroupResponse,Void> retrieveGroups()
public com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> retrieveIdentityProvider(UUID identityProviderId)
identityProviderId
- The identity provider Id.public com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> retrieveIdentityProviderByType(IdentityProviderType type)
type
- The type of the identity provider.public com.inversoft.rest.ClientResponse<IdentityProviderResponse,Void> retrieveIdentityProviders()
public com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> retrieveInactiveActions(UUID userId)
userId
- The Id of the user to fetch the actions for.public com.inversoft.rest.ClientResponse<ApplicationResponse,Void> retrieveInactiveApplications()
public com.inversoft.rest.ClientResponse<UserActionResponse,Void> retrieveInactiveUserActions()
public com.inversoft.rest.ClientResponse<IntegrationResponse,Void> retrieveIntegration()
public com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> retrieveJWTPublicKey(String keyId)
keyId
- The Id of the public key (kid).public com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> retrieveJWTPublicKeyByApplicationId(String applicationId)
applicationId
- The Id of the Application for which this key is used.public com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> retrieveJWTPublicKeys()
public com.inversoft.rest.ClientResponse<JWKSResponse,Void> retrieveJsonWebKeySet()
public com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> retrieveKey(UUID keyId)
keyId
- The Id of the key.public com.inversoft.rest.ClientResponse<KeyResponse,Void> retrieveKeys()
public com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> retrieveLambda(UUID lambdaId)
lambdaId
- The Id of the lambda.public com.inversoft.rest.ClientResponse<LambdaResponse,Void> retrieveLambdas()
public com.inversoft.rest.ClientResponse<LambdaResponse,Void> retrieveLambdasByType(LambdaType type)
type
- The type of the lambda to return.public com.inversoft.rest.ClientResponse<LoginReportResponse,com.inversoft.error.Errors> retrieveLoginReport(UUID applicationId, long start, long end)
applicationId
- (Optional) The application id.start
- The start instant as UTC milliseconds since Epoch.end
- The end instant as UTC milliseconds since Epoch.public com.inversoft.rest.ClientResponse<MessageTemplateResponse,Void> retrieveMessageTemplate(UUID messageTemplateId)
messageTemplateId
- (Optional) The Id of the message template.public com.inversoft.rest.ClientResponse<PreviewMessageTemplateResponse,com.inversoft.error.Errors> retrieveMessageTemplatePreview(PreviewMessageTemplateRequest request)
request
- The request that contains the email template and optionally a locale to render it in.public com.inversoft.rest.ClientResponse<MessageTemplateResponse,Void> retrieveMessageTemplates()
public com.inversoft.rest.ClientResponse<MessengerResponse,Void> retrieveMessenger(UUID messengerId)
messengerId
- The Id of the messenger.public com.inversoft.rest.ClientResponse<MessengerResponse,Void> retrieveMessengers()
public com.inversoft.rest.ClientResponse<MonthlyActiveUserReportResponse,com.inversoft.error.Errors> retrieveMonthlyActiveReport(UUID applicationId, long start, long end)
applicationId
- (Optional) The application id.start
- The start instant as UTC milliseconds since Epoch.end
- The end instant as UTC milliseconds since Epoch.public com.inversoft.rest.ClientResponse<OAuthConfigurationResponse,com.inversoft.error.Errors> retrieveOauthConfiguration(UUID applicationId)
applicationId
- The Id of the Application to retrieve OAuth configuration.public com.inversoft.rest.ClientResponse<OpenIdConfiguration,Void> retrieveOpenIdConfiguration()
public com.inversoft.rest.ClientResponse<PasswordValidationRulesResponse,Void> retrievePasswordValidationRules()
public com.inversoft.rest.ClientResponse<PasswordValidationRulesResponse,Void> retrievePasswordValidationRulesWithTenantId(UUID tenantId)
tenantId
- The Id of the tenant.public com.inversoft.rest.ClientResponse<PendingResponse,com.inversoft.error.Errors> retrievePendingChildren(String parentEmail)
parentEmail
- The email of the parent.public com.inversoft.rest.ClientResponse<ReactorResponse,Void> retrieveReactorStatus()
public com.inversoft.rest.ClientResponse<RecentLoginResponse,com.inversoft.error.Errors> retrieveRecentLogins(int offset, Integer limit)
offset
- The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.limit
- (Optional, defaults to 10) The number of records to retrieve.public com.inversoft.rest.ClientResponse<RefreshTokenResponse,com.inversoft.error.Errors> retrieveRefreshTokenById(UUID userId)
userId
- The Id of the user.public com.inversoft.rest.ClientResponse<RefreshTokenResponse,com.inversoft.error.Errors> retrieveRefreshTokens(UUID userId)
userId
- The Id of the user.public com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> retrieveRegistration(UUID userId, UUID applicationId)
userId
- The Id of the user.applicationId
- The Id of the application.public com.inversoft.rest.ClientResponse<RegistrationReportResponse,com.inversoft.error.Errors> retrieveRegistrationReport(UUID applicationId, long start, long end)
applicationId
- (Optional) The application id.start
- The start instant as UTC milliseconds since Epoch.end
- The end instant as UTC milliseconds since Epoch.public com.inversoft.rest.ClientResponse<SystemConfigurationResponse,Void> retrieveSystemConfiguration()
public com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> retrieveTenant(UUID tenantId)
tenantId
- The Id of the tenant.public com.inversoft.rest.ClientResponse<TenantResponse,Void> retrieveTenants()
public com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> retrieveTheme(UUID themeId)
themeId
- The Id of the theme.public com.inversoft.rest.ClientResponse<ThemeResponse,Void> retrieveThemes()
public com.inversoft.rest.ClientResponse<TotalsReportResponse,Void> retrieveTotalReport()
public com.inversoft.rest.ClientResponse<TwoFactorRecoveryCodeResponse,com.inversoft.error.Errors> retrieveTwoFactorRecoveryCodes(UUID userId)
userId
- The Id of the user to retrieve Two Factor recovery codes.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUser(UUID userId)
userId
- The Id of the user.public com.inversoft.rest.ClientResponse<UserActionResponse,Void> retrieveUserAction(UUID userActionId)
userActionId
- (Optional) The Id of the user action.public com.inversoft.rest.ClientResponse<UserActionReasonResponse,Void> retrieveUserActionReason(UUID userActionReasonId)
userActionReasonId
- (Optional) The Id of the user action reason.public com.inversoft.rest.ClientResponse<UserActionReasonResponse,Void> retrieveUserActionReasons()
public com.inversoft.rest.ClientResponse<UserActionResponse,Void> retrieveUserActions()
public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUserByChangePasswordId(String changePasswordId)
changePasswordId
- The unique change password Id that was sent via email or returned by the Forgot Password API.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUserByEmail(String email)
email
- The email of the user.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUserByLoginId(String loginId)
loginId
- The email or username of the user.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUserByUsername(String username)
username
- The username of the user.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUserByVerificationId(String verificationId)
verificationId
- The unique verification Id that has been set on the user object.public com.inversoft.rest.ClientResponse<UserCommentResponse,com.inversoft.error.Errors> retrieveUserComments(UUID userId)
userId
- The Id of the user.public com.inversoft.rest.ClientResponse<UserConsentResponse,Void> retrieveUserConsent(UUID userConsentId)
userConsentId
- The User consent Idpublic com.inversoft.rest.ClientResponse<UserConsentResponse,Void> retrieveUserConsents(UUID userId)
userId
- The User's Idpublic com.inversoft.rest.ClientResponse<UserResponse,OAuthError> retrieveUserInfoFromAccessToken(String encodedJWT)
encodedJWT
- The encoded JWT (access token).public com.inversoft.rest.ClientResponse<LoginReportResponse,com.inversoft.error.Errors> retrieveUserLoginReport(UUID applicationId, UUID userId, long start, long end)
applicationId
- (Optional) The application id.userId
- The userId id.start
- The start instant as UTC milliseconds since Epoch.end
- The end instant as UTC milliseconds since Epoch.public com.inversoft.rest.ClientResponse<LoginReportResponse,com.inversoft.error.Errors> retrieveUserLoginReportByLoginId(UUID applicationId, String loginId, long start, long end)
applicationId
- (Optional) The application id.loginId
- The userId id.start
- The start instant as UTC milliseconds since Epoch.end
- The end instant as UTC milliseconds since Epoch.public com.inversoft.rest.ClientResponse<RecentLoginResponse,com.inversoft.error.Errors> retrieveUserRecentLogins(UUID userId, int offset, Integer limit)
userId
- The Id of the user.offset
- The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.limit
- (Optional, defaults to 10) The number of records to retrieve.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> retrieveUserUsingJWT(String encodedJWT)
encodedJWT
- The encoded JWT (access token).public com.inversoft.rest.ClientResponse<VersionResponse,com.inversoft.error.Errors> retrieveVersion()
public com.inversoft.rest.ClientResponse<WebhookResponse,Void> retrieveWebhook(UUID webhookId)
webhookId
- (Optional) The Id of the webhook.public com.inversoft.rest.ClientResponse<WebhookResponse,Void> retrieveWebhooks()
public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> revokeRefreshToken(String token, UUID userId, UUID applicationId)
null
may be handled differently depending upon the programming language.
See also: (method names may vary by language... but you'll figure it out)
- revokeRefreshTokenById
- revokeRefreshTokenByToken
- revokeRefreshTokensByUserId
- revokeRefreshTokensByApplicationId
- revokeRefreshTokensByUserIdForApplicationtoken
- (Optional) The refresh token to delete.userId
- (Optional) The user id whose tokens to delete.applicationId
- (Optional) The application id of the tokens to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> revokeRefreshTokenById(UUID tokenId)
tokenId
- The unique Id of the token to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> revokeRefreshTokenByToken(String token)
token
- The refresh token to delete.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> revokeRefreshTokensByApplicationId(UUID applicationId)
applicationId
- The unique Id of the application that you want to delete all refresh tokens for.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> revokeRefreshTokensByUserId(UUID userId)
userId
- The unique Id of the user that you want to delete all refresh tokens for.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> revokeRefreshTokensByUserIdForApplication(UUID userId, UUID applicationId)
userId
- The unique Id of the user that you want to delete all refresh tokens for.applicationId
- The unique Id of the application that you want to delete refresh tokens for.public com.inversoft.rest.ClientResponse<Void,Void> revokeUserConsent(UUID userConsentId)
userConsentId
- The User Consent Idpublic com.inversoft.rest.ClientResponse<AuditLogSearchResponse,Void> searchAuditLogs(AuditLogSearchRequest request)
request
- The search criteria and pagination information.public com.inversoft.rest.ClientResponse<EntitySearchResponse,com.inversoft.error.Errors> searchEntities(EntitySearchRequest request)
request
- The search criteria and pagination information.public com.inversoft.rest.ClientResponse<EntitySearchResponse,com.inversoft.error.Errors> searchEntitiesByIds(Collection<UUID> ids)
ids
- The entity ids to search for.public com.inversoft.rest.ClientResponse<EntityGrantSearchResponse,com.inversoft.error.Errors> searchEntityGrants(EntityGrantSearchRequest request)
request
- The search criteria and pagination information.public com.inversoft.rest.ClientResponse<EntityTypeSearchResponse,Void> searchEntityTypes(EntityTypeSearchRequest request)
request
- The search criteria and pagination information.public com.inversoft.rest.ClientResponse<EventLogSearchResponse,Void> searchEventLogs(EventLogSearchRequest request)
request
- The search criteria and pagination information.public com.inversoft.rest.ClientResponse<LoginRecordSearchResponse,Void> searchLoginRecords(LoginRecordSearchRequest request)
request
- The search criteria and pagination information.@Deprecated public com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> searchUsers(Collection<UUID> ids)
ids
- The user ids to search for.public com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> searchUsersByIds(Collection<UUID> ids)
ids
- The user ids to search for.public com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> searchUsersByQuery(SearchRequest request)
request
- The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
and sortFields.@Deprecated public com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> searchUsersByQueryString(SearchRequest request)
request
- The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
and sortFields.public com.inversoft.rest.ClientResponse<SendResponse,com.inversoft.error.Errors> sendEmail(UUID emailTemplateId, SendRequest request)
requestData
to access key value
pairs in the email template.emailTemplateId
- The id for the template.request
- The send email request that contains all of the information used to send the email.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> sendFamilyRequestEmail(FamilyEmailRequest request)
request
- The request object that contains the parent email.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> sendPasswordlessCode(PasswordlessSendRequest request)
request
- The passwordless send request that contains all of the information used to send an email containing a code.@Deprecated public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> sendTwoFactorCode(TwoFactorSendRequest request)
request
- The request object that contains all of the information used to send the code.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> sendTwoFactorCodeForEnableDisable(TwoFactorSendRequest request)
request
- The request object that contains all of the information used to send the code.@Deprecated public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> sendTwoFactorCodeForLogin(String twoFactorId)
twoFactorId
- The Id returned by the Login API necessary to complete Two Factor authentication.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> sendTwoFactorCodeForLoginUsingMethod(String twoFactorId, TwoFactorSendRequest request)
twoFactorId
- The Id returned by the Login API necessary to complete Two Factor authentication.request
- The Two Factor send request that contains all of the information used to send the Two Factor code to the user.public com.inversoft.rest.ClientResponse<IdentityProviderStartLoginResponse,com.inversoft.error.Errors> startIdentityProviderLogin(IdentityProviderStartLoginRequest request)
request
- The third-party login request that contains information from the third-party login
providers that FusionAuth uses to reconcile the user's account.public com.inversoft.rest.ClientResponse<PasswordlessStartResponse,com.inversoft.error.Errors> startPasswordlessLogin(PasswordlessStartRequest request)
request
- The passwordless start request that contains all of the information used to begin the passwordless login request.public com.inversoft.rest.ClientResponse<TwoFactorStartResponse,com.inversoft.error.Errors> startTwoFactorLogin(TwoFactorStartRequest request)
request
- The Two-Factor start request that contains all of the information used to begin the Two-Factor login request.public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> twoFactorLogin(TwoFactorLoginRequest request)
request
- The login request that contains the user credentials used to log them in.public com.inversoft.rest.ClientResponse<APIKeyResponse,com.inversoft.error.Errors> updateAPIKey(UUID apiKeyId, APIKeyRequest request)
apiKeyId
- The Id of the API key to update.request
- The request object that contains all of the information used to create the API Key.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> updateApplication(UUID applicationId, ApplicationRequest request)
applicationId
- The Id of the application to update.request
- The request that contains all of the new application information.public com.inversoft.rest.ClientResponse<ApplicationResponse,com.inversoft.error.Errors> updateApplicationRole(UUID applicationId, UUID roleId, ApplicationRequest request)
applicationId
- The Id of the application that the role belongs to.roleId
- The Id of the role to update.request
- The request that contains all of the new role information.public com.inversoft.rest.ClientResponse<ConnectorResponse,com.inversoft.error.Errors> updateConnector(UUID connectorId, ConnectorRequest request)
connectorId
- The Id of the connector to update.request
- The request object that contains all of the new connector information.public com.inversoft.rest.ClientResponse<ConsentResponse,com.inversoft.error.Errors> updateConsent(UUID consentId, ConsentRequest request)
consentId
- The Id of the consent to update.request
- The request that contains all of the new consent information.public com.inversoft.rest.ClientResponse<EmailTemplateResponse,com.inversoft.error.Errors> updateEmailTemplate(UUID emailTemplateId, EmailTemplateRequest request)
emailTemplateId
- The Id of the email template to update.request
- The request that contains all of the new email template information.public com.inversoft.rest.ClientResponse<EntityResponse,com.inversoft.error.Errors> updateEntity(UUID entityId, EntityRequest request)
entityId
- The Id of the Entity to update.request
- The request that contains all of the new Entity information.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> updateEntityType(UUID entityTypeId, EntityTypeRequest request)
entityTypeId
- The Id of the Entity Type to update.request
- The request that contains all of the new Entity Type information.public com.inversoft.rest.ClientResponse<EntityTypeResponse,com.inversoft.error.Errors> updateEntityTypePermission(UUID entityTypeId, UUID permissionId, EntityTypeRequest request)
entityTypeId
- The Id of the entityType that the permission belongs to.permissionId
- The Id of the permission to update.request
- The request that contains all of the new permission information.public com.inversoft.rest.ClientResponse<FormResponse,com.inversoft.error.Errors> updateForm(UUID formId, FormRequest request)
formId
- The Id of the form to update.request
- The request object that contains all of the new form information.public com.inversoft.rest.ClientResponse<FormFieldResponse,com.inversoft.error.Errors> updateFormField(UUID fieldId, FormFieldRequest request)
fieldId
- The Id of the form field to update.request
- The request object that contains all of the new form field information.public com.inversoft.rest.ClientResponse<GroupResponse,com.inversoft.error.Errors> updateGroup(UUID groupId, GroupRequest request)
groupId
- The Id of the group to update.request
- The request that contains all of the new group information.public com.inversoft.rest.ClientResponse<IdentityProviderResponse,com.inversoft.error.Errors> updateIdentityProvider(UUID identityProviderId, IdentityProviderRequest request)
identityProviderId
- The Id of the identity provider to update.request
- The request object that contains the updated identity provider.public com.inversoft.rest.ClientResponse<IntegrationResponse,com.inversoft.error.Errors> updateIntegrations(IntegrationRequest request)
request
- The request that contains all of the new integration information.public com.inversoft.rest.ClientResponse<KeyResponse,com.inversoft.error.Errors> updateKey(UUID keyId, KeyRequest request)
keyId
- The Id of the key to update.request
- The request that contains all of the new key information.public com.inversoft.rest.ClientResponse<LambdaResponse,com.inversoft.error.Errors> updateLambda(UUID lambdaId, LambdaRequest request)
lambdaId
- The Id of the lambda to update.request
- The request that contains all of the new lambda information.public com.inversoft.rest.ClientResponse<MessageTemplateResponse,com.inversoft.error.Errors> updateMessageTemplate(UUID messageTemplateId, MessageTemplateRequest request)
messageTemplateId
- The Id of the message template to update.request
- The request that contains all of the new message template information.public com.inversoft.rest.ClientResponse<MessengerResponse,com.inversoft.error.Errors> updateMessenger(UUID messengerId, MessengerRequest request)
messengerId
- The Id of the messenger to update.request
- The request object that contains all of the new messenger information.public com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> updateRegistration(UUID userId, RegistrationRequest request)
userId
- The Id of the user whose registration is going to be updated.request
- The request that contains all of the new registration information.public com.inversoft.rest.ClientResponse<SystemConfigurationResponse,com.inversoft.error.Errors> updateSystemConfiguration(SystemConfigurationRequest request)
request
- The request that contains all of the new system configuration information.public com.inversoft.rest.ClientResponse<TenantResponse,com.inversoft.error.Errors> updateTenant(UUID tenantId, TenantRequest request)
tenantId
- The Id of the tenant to update.request
- The request that contains all of the new tenant information.public com.inversoft.rest.ClientResponse<ThemeResponse,com.inversoft.error.Errors> updateTheme(UUID themeId, ThemeRequest request)
themeId
- The Id of the theme to update.request
- The request that contains all of the new theme information.public com.inversoft.rest.ClientResponse<UserResponse,com.inversoft.error.Errors> updateUser(UUID userId, UserRequest request)
userId
- The Id of the user to update.request
- The request that contains all of the new user information.public com.inversoft.rest.ClientResponse<UserActionResponse,com.inversoft.error.Errors> updateUserAction(UUID userActionId, UserActionRequest request)
userActionId
- The Id of the user action to update.request
- The request that contains all of the new user action information.public com.inversoft.rest.ClientResponse<UserActionReasonResponse,com.inversoft.error.Errors> updateUserActionReason(UUID userActionReasonId, UserActionReasonRequest request)
userActionReasonId
- The Id of the user action reason to update.request
- The request that contains all of the new user action reason information.public com.inversoft.rest.ClientResponse<UserConsentResponse,com.inversoft.error.Errors> updateUserConsent(UUID userConsentId, UserConsentRequest request)
userConsentId
- The User Consent Idrequest
- The request that contains the user consent information.public com.inversoft.rest.ClientResponse<WebhookResponse,com.inversoft.error.Errors> updateWebhook(UUID webhookId, WebhookRequest request)
webhookId
- The Id of the webhook to update.request
- The request that contains all of the new webhook information.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> upsertEntityGrant(UUID entityId, EntityGrantRequest request)
entityId
- The Id of the Entity that the User/Entity is being granted access to.request
- The request object that contains all of the information used to create the Entity Grant.public com.inversoft.rest.ClientResponse<Void,Void> validateDevice(String user_code, String client_id)
user_code
- The end-user verification code.client_id
- The client id.public com.inversoft.rest.ClientResponse<ValidateResponse,Void> validateJWT(String encodedJWT)
This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims.
encodedJWT
- The encoded JWT (access token).@Deprecated public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> verifyEmail(String verificationId)
verificationId
- The email verification id sent to the user.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> verifyEmailAddress(VerifyEmailRequest request)
request
- The request that contains the verificationId and optional one-time use code paired with the verificationId.@Deprecated public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> verifyRegistration(String verificationId)
verificationId
- The registration verification Id sent to the user.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> verifyUserRegistration(VerifyRegistrationRequest request)
request
- The request that contains the verificationId and optional one-time use code paired with the verificationId.Copyright © 2021. All rights reserved.