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(UUID actioneeUserId,
ActionRequest request)
Takes an action on a user.
|
com.inversoft.rest.ClientResponse<ActionResponse,com.inversoft.error.Errors> |
cancelAction(UUID actionId,
ActionRequest request)
Cancels the user action.
|
com.inversoft.rest.ClientResponse<Void,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<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<EmailTemplateResponse,com.inversoft.error.Errors> |
createEmailTemplate(UUID emailTemplateId,
EmailTemplateRequest request)
Creates an email template.
|
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<TenantResponse,com.inversoft.error.Errors> |
createTenant(UUID tenantId,
TenantRequest request)
Creates a tenant.
|
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<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,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<Void,com.inversoft.error.Errors> |
deactivateUsers(Collection<UUID> userIds)
Deactivates the users with the given ids.
|
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> |
deleteEmailTemplate(UUID emailTemplateId)
Deletes the email template 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> |
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> |
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<Void,com.inversoft.error.Errors> |
deleteUsers(UserDeleteRequest request)
Deletes the users with the given ids.
|
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 code)
Disable Two Factor authentication for a user.
|
com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> |
enableTwoFactor(UUID userId,
TwoFactorRequest request)
Enable Two Factor authentication for a user.
|
com.inversoft.rest.ClientResponse<RefreshResponse,com.inversoft.error.Errors> |
exchangeRefreshTokenForJWT(RefreshRequest request)
Exchange a refresh token for a new JWT.
|
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<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<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<Void,com.inversoft.error.Errors> |
importUsers(ImportRequest request)
Bulk imports multiple users.
|
com.inversoft.rest.ClientResponse<IssueResponse,com.inversoft.error.Errors> |
issueJWT(UUID applicationId,
String encodedJWT)
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)
Logs a user in.
|
com.inversoft.rest.ClientResponse<Void,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<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(ReconcileRequest request)
Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
|
com.inversoft.rest.ClientResponse<RegistrationResponse,com.inversoft.error.Errors> |
register(UUID userId,
RegistrationRequest request)
Registers a user for an application.
|
com.inversoft.rest.ClientResponse<VerifyEmailResponse,Void> |
resendEmailVerification(String email)
Re-sends the verification email to the user.
|
com.inversoft.rest.ClientResponse<VerifyRegistrationResponse,Void> |
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<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<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<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,Void> |
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,Void> |
retrieveIdentityProviders()
Retrieves all of the identity providers.
|
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<PublicKeyResponse,Void> |
retrieveJWTPublicKey(String keyId)
Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id.
|
com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> |
retrieveJWTPublicKeys()
Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
|
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<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<PasswordValidationRulesResponse,Void> |
retrievePasswordValidationRules()
Retrieves the password validation rules.
|
com.inversoft.rest.ClientResponse<RefreshResponse,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<TotalsReportResponse,Void> |
retrieveTotalReport()
Retrieves the totals report.
|
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<UserLoginReportResponse,com.inversoft.error.Errors> |
retrieveUserLoginReport(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<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 a single refresh token, all tokens for a user or all tokens for an application.
|
com.inversoft.rest.ClientResponse<AuditLogSearchResponse,Void> |
searchAuditLogs(AuditLogSearchRequest request)
Searches the audit logs with the specified criteria and pagination.
|
com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> |
searchUsers(Collection<UUID> ids)
Retrieves the users for the given ids.
|
com.inversoft.rest.ClientResponse<SearchResponse,com.inversoft.error.Errors> |
searchUsersByQueryString(SearchRequest request)
Retrieves the users for the given search criteria and pagination.
|
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> |
sendTwoFactorCode(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)
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) |
com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> |
twoFactorLogin(TwoFactorLoginRequest request)
Complete login using a 2FA challenge
|
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<EmailTemplateResponse,com.inversoft.error.Errors> |
updateEmailTemplate(UUID emailTemplateId,
EmailTemplateRequest request)
Updates the email template 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<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<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<WebhookResponse,com.inversoft.error.Errors> |
updateWebhook(UUID webhookId,
WebhookRequest request)
Updates the webhook with the given Id.
|
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,Void> |
verifyEmail(String verificationId)
Confirms a email verification.
|
com.inversoft.rest.ClientResponse<Void,Void> |
verifyRegistration(String verificationId)
Confirms an application 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(UUID actioneeUserId, ActionRequest request)
actioneeUserId
- The actionee's user id.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<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<Void,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<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<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<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<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<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<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,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.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deactivateUsers(Collection<UUID> userIds)
userIds
- The ids of the users to deactivate.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> deleteEmailTemplate(UUID emailTemplateId)
emailTemplateId
- The Id of the email template 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> 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> 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.public com.inversoft.rest.ClientResponse<Void,com.inversoft.error.Errors> deleteUsers(UserDeleteRequest request)
request
- The ids of the users to delete.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 code)
userId
- The Id of the User for which you're disabling Two Factor authentication.code
- The Two Factor code used verify the the caller knows the Two Factor secret.public com.inversoft.rest.ClientResponse<Void,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<RefreshResponse,com.inversoft.error.Errors> exchangeRefreshTokenForJWT(RefreshRequest request)
request
- The refresh request.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<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<SecretResponse,Void> generateTwoFactorSecret()
public com.inversoft.rest.ClientResponse<SecretResponse,Void> generateTwoFactorSecretUsingJWT(String encodedJWT)
encodedJWT
- The encoded JWT (access token).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<IssueResponse,com.inversoft.error.Errors> issueJWT(UUID applicationId, String encodedJWT)
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).public com.inversoft.rest.ClientResponse<LoginResponse,com.inversoft.error.Errors> login(LoginRequest request)
request
- The login request that contains the user credentials used to log them in.public com.inversoft.rest.ClientResponse<Void,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<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(ReconcileRequest request)
request
- The reconcile request that contains the data to reconcile the User.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<VerifyEmailResponse,Void> resendEmailVerification(String email)
email
- The email address of the user that needs a new verification email.public com.inversoft.rest.ClientResponse<VerifyRegistrationResponse,Void> 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<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<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<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<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,Void> retrieveIdentityProvider(UUID identityProviderId)
identityProviderId
- (Optional) The identity provider id.public com.inversoft.rest.ClientResponse<IdentityProviderResponse,Void> retrieveIdentityProviders()
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
- (Optional) The Id of the public key.public com.inversoft.rest.ClientResponse<PublicKeyResponse,Void> retrieveJWTPublicKeys()
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<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<PasswordValidationRulesResponse,Void> retrievePasswordValidationRules()
public com.inversoft.rest.ClientResponse<RefreshResponse,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<TotalsReportResponse,Void> retrieveTotalReport()
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<UserLoginReportResponse,com.inversoft.error.Errors> retrieveUserLoginReport(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<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)
token
- (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<AuditLogSearchResponse,Void> searchAuditLogs(AuditLogSearchRequest request)
request
- The search criteria and pagination information.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> searchUsersByQueryString(SearchRequest request)
request
- The search criteria and pagination constraints. Fields used: queryString, numberOfResults, startRow,
and sort fields.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> 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> sendTwoFactorCodeForLogin(String twoFactorId)
twoFactorId
- The Id returned by the Login API necessary to complete Two Factor authentication.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<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<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<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<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<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<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<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).public com.inversoft.rest.ClientResponse<Void,Void> verifyEmail(String verificationId)
verificationId
- The email verification id sent to the user.public com.inversoft.rest.ClientResponse<Void,Void> verifyRegistration(String verificationId)
verificationId
- The registration verification Id sent to the user.Copyright © 2018. All rights reserved.