fusionauth_dart_client library

Support for doing something awesome.

More dartdocs go here.

Classes

AccessToken
@author Daniel DeGroff
ActionData
ActionRequest
The user action request object.
ActionResponse
The user action response object.
APIKey
domain POJO to represent AuthenticationKey
APIKeyMetaData
APIKeyPermissions
APIKeyRequest
Authentication key request object.
APIKeyResponse
Authentication key response object.
AppleApplicationConfiguration
@author Daniel DeGroff
AppleIdentityProvider
@author Daniel DeGroff
Application
@author Seth Musselman
ApplicationAccessControlConfiguration
@author Daniel DeGroff
ApplicationEmailConfiguration
ApplicationEvent
Events that are bound to applications.
ApplicationExternalIdentifierConfiguration
@author Daniel DeGroff
ApplicationFormConfiguration
@author Daniel DeGroff
ApplicationMultiFactorConfiguration
@author Daniel DeGroff
ApplicationRegistrationDeletePolicy
A Application-level policy for deleting Users.
ApplicationRequest
The Application API request object.
ApplicationResponse
The Application API response.
ApplicationRole
A role given to a user for a specific application.
ApplicationSearchCriteria
Search criteria for Applications
ApplicationSearchRequest
Search request for Applications
ApplicationSearchResponse
Application search response
ApplicationUnverifiedConfiguration
@author Daniel DeGroff
ApplicationWebAuthnConfiguration
Application-level configuration for WebAuthn
ApplicationWebAuthnWorkflowConfiguration
@author Daniel DeGroff
Attachment
This class is a simple attachment with a byte array, name and MIME type.
AuditLog
An audit log.
AuditLogConfiguration
AuditLogCreateEvent
Event event to an audit log was created.
AuditLogExportRequest
@author Daniel DeGroff
AuditLogRequest
@author Brian Pontarelli
AuditLogResponse
Audit log response.
AuditLogSearchCriteria
@author Brian Pontarelli
AuditLogSearchRequest
@author Brian Pontarelli
AuditLogSearchResponse
Audit log response.
AuthenticationTokenConfiguration
AuthenticatorConfiguration
@author Daniel DeGroff
AuthenticatorSelectionCriteria
Used by the Relying Party to specify their requirements for authenticator attributes. Fields use the deprecated "resident key" terminology to refer to client-side discoverable credentials to maintain backwards compatibility with WebAuthn Level 1.
BaseConnectorConfiguration
BaseElasticSearchCriteria
@author Brian Pontarelli
BaseEvent
Base-class for all FusionAuth events.
BaseEventRequest
Base class for requests that can contain event information. This event information is used when sending Webhooks or emails during the transaction. The caller is responsible for ensuring that the event information is correct.
BaseExportRequest
@author Daniel DeGroff
BaseIdentityProvider<D extends BaseIdentityProviderApplicationConfiguration>
BaseIdentityProviderApplicationConfiguration
@author Daniel DeGroff
BaseLoginRequest
@author Daniel DeGroff
BaseMessengerConfiguration
BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplicationConfiguration>
@author Lyle Schemmerling
BaseSearchCriteria
@author Brian Pontarelli
BreachedPasswordTenantMetric
@author Daniel DeGroff
CertificateInformation
ChangePasswordRequest
Change password request object.
ChangePasswordResponse
Change password response object.
CleanSpeakConfiguration
CleanSpeak configuration at the system and application level.
ClientResponse<RT, ERT>
ConnectorPolicy
@author Trevor Smith
ConnectorRequest
@author Trevor Smith
ConnectorResponse
@author Trevor Smith
Models a consent.
ConsentRequest
API request for User consent types.
ConsentResponse
API response for consent.
ConsentSearchCriteria
Search criteria for Consents
ConsentSearchRequest
Search request for Consents
ConsentSearchResponse
Consent search response
CORSConfiguration
@author Trevor Smith
Count
@author Brian Pontarelli
CredentialPropertiesOutput
Contains the output for the {@code credProps} extension
DailyActiveUserReportResponse
Response for the daily active user report.
DeleteConfiguration
DeviceApprovalResponse
@author Daniel DeGroff
DeviceInfo
@author Daniel DeGroff
DeviceResponse
@author Trevor Smith
DeviceUserCodeResponse
@author Daniel DeGroff
DisplayableRawLogin
A displayable raw login that includes application name and user loginId.
DomainBasedIdentityProvider
Interface for all identity providers that can be domain based.
Email
This class is an abstraction of a simple email message.
EmailAddress
An email address.
EmailConfiguration
@author Brian Pontarelli
EmailHeader
@author Daniel DeGroff
EmailPlus
EmailTemplate
Stores an email template used to send emails to users.
EmailTemplateErrors
EmailTemplateRequest
Email template request.
EmailTemplateResponse
Email template response.
EmailTemplateSearchCriteria
Search criteria for Email templates
EmailTemplateSearchRequest
Search request for email templates
EmailTemplateSearchResponse
Email template search response
EmailUnverifiedOptions
@author Daniel DeGroff
Enableable
Something that can be enabled and thus also disabled.
Entity
Models an entity that a user can be granted permissions to. Or an entity that can be granted permissions to another entity.
EntityGrant
A grant for an entity to a user or another entity.
EntityGrantRequest
Entity grant API request object.
EntityGrantResponse
Entity grant API response object.
EntityGrantSearchCriteria
Search criteria for entity grants.
EntityGrantSearchRequest
Search request for entity grants.
EntityGrantSearchResponse
Search request for entity grants.
EntityJWTConfiguration
JWT Configuration for entities.
EntityRequest
Entity API request object.
EntityResponse
Entity API response object.
EntitySearchCriteria
This class is the entity query. It provides a build pattern as well as public fields for use on forms and in actions.
EntitySearchRequest
Search request for entities
EntitySearchResponse
Search request for entities
EntityType
Models an entity type that has a specific set of permissions. These are global objects and can be used across tenants.
EntityTypePermission
Models a specific entity type permission. This permission can be granted to users or other entities.
EntityTypeRequest
Entity Type API request object.
EntityTypeResponse
Entity Type API response object.
EntityTypeSearchCriteria
Search criteria for entity types.
EntityTypeSearchRequest
Search request for entity types.
EntityTypeSearchResponse
Search response for entity types.
EpicGamesApplicationConfiguration
@author Brett Pontarelli
EpicGamesIdentityProvider
Epic gaming login provider.
Error
Defines an error.
Errors
Standard error domain object that can also be used as the response from an API call.
EventConfiguration
@author Brian Pontarelli
EventConfigurationData
EventInfo
Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
EventLog
Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc.
EventLogConfiguration
EventLogCreateEvent
An Event "event" to indicate an event log was created.
EventLogResponse
Event log response.
EventLogSearchCriteria
Search criteria for the event log.
EventLogSearchRequest
@author Brian Pontarelli
EventLogSearchResponse
Event log response.
EventRequest
Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
ExpandableRequest
An expandable API request.
ExpandableResponse
An expandable API response.
ExternalIdentifierConfiguration
@author Daniel DeGroff
ExternalJWTApplicationConfiguration
@author Daniel DeGroff
ExternalJWTIdentityProvider
External JWT-only identity provider.
FacebookApplicationConfiguration
@author Daniel DeGroff
FacebookIdentityProvider
Facebook social login provider.
FailedAuthenticationActionCancelPolicy
A policy to configure if and when the user-action is canceled prior to the expiration of the action.
FailedAuthenticationConfiguration
Configuration for the behavior of failed login attempts. This helps us protect against brute force password attacks.
Family
Models a family grouping of users.
FamilyConfiguration
@author Brian Pontarelli
FamilyEmailRequest
API request for sending out family requests to parent's.
FamilyMember
Models a single family member.
FamilyRequest
API request for managing families and members.
FamilyResponse
API response for managing families and members.
ForgotPasswordRequest
Forgot password request object.
ForgotPasswordResponse
Forgot password response object.
Form
@author Daniel DeGroff
FormField
@author Daniel DeGroff
FormFieldRequest
The FormField API request object.
FormFieldResponse
Form field response.
FormFieldValidator
@author Daniel DeGroff
FormRequest
Form response.
FormResponse
Form response.
FormStep
@author Daniel DeGroff
FusionAuthClient
FusionAuthConnectorConfiguration
Models the FusionAuth connector.
FusionAuthRESTClient<ReturnType, ErrorReturnType>
GenericConnectorConfiguration
Models a generic connector.
GenericMessengerConfiguration
@author Brett Guy
GoogleApplicationConfiguration
@author Daniel DeGroff
GoogleIdentityProvider
Google social login provider.
GoogleIdentityProviderProperties
Google social login provider parameters.
Group
@author Tyler Scott
GroupCreateCompleteEvent
Models the Group Created Event.
GroupCreateEvent
Models the Group Create Event.
GroupDeleteCompleteEvent
Models the Group Create Complete Event.
GroupDeleteEvent
Models the Group Delete Event.
GroupMember
A User's membership into a Group
GroupMemberAddCompleteEvent
Models the Group Member Add Complete Event.
GroupMemberAddEvent
Models the Group Member Add Event.
GroupMemberRemoveCompleteEvent
Models the Group Member Remove Complete Event.
GroupMemberRemoveEvent
Models the Group Member Remove Event.
GroupMemberSearchCriteria
Search criteria for Group Members
GroupMemberSearchRequest
Search request for Group Members.
GroupMemberSearchResponse
Search response for Group Members
GroupMemberUpdateCompleteEvent
Models the Group Member Update Complete Event.
GroupMemberUpdateEvent
Models the Group Member Update Event.
GroupRequest
Group API request object.
GroupResponse
Group API response object.
GroupSearchCriteria
Search criteria for Groups
GroupSearchRequest
Search request for Groups.
GroupSearchResponse
Search response for Groups
GroupUpdateCompleteEvent
Models the Group Update Complete Event.
GroupUpdateEvent
Models the Group Update Event.
HistoryItem
HYPRApplicationConfiguration
@author Daniel DeGroff
HYPRIdentityProvider
@author Daniel DeGroff
IdentityProviderDetails
IdentityProviderLimitUserLinkingPolicy
@author Daniel DeGroff
@author Daniel DeGroff
IdentityProviderLinkRequest
@author Daniel DeGroff
IdentityProviderLinkResponse
@author Daniel DeGroff
IdentityProviderLoginRequest
Login API request object used for login to third-party systems (i.e. Login with Facebook).
IdentityProviderOauth2Configuration
@author Daniel DeGroff
IdentityProviderPendingLinkResponse
@author Daniel DeGroff
IdentityProviderRequest
@author Daniel DeGroff
IdentityProviderResponse
@author Daniel DeGroff
IdentityProviderSearchCriteria
Search criteria for Identity Providers.
IdentityProviderSearchRequest
Search request for Identity Providers
IdentityProviderSearchResponse
Identity Provider response.
IdentityProviderStartLoginRequest
@author Daniel DeGroff
IdentityProviderStartLoginResponse
@author Daniel DeGroff
IdentityProviderTenantConfiguration
@author Daniel DeGroff
ImportRequest
Import request.
InstanceEvent
A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks.
IntegrationRequest
The Integration Request
IntegrationResponse
The Integration Response
Integrations
Available Integrations
IPAccessControlEntry
@author Brett Guy
IPAccessControlList
@author Brett Guy
IPAccessControlListRequest
@author Brett Guy
IPAccessControlListResponse
@author Brett Guy
IPAccessControlListSearchCriteria
@author Brett Guy
IPAccessControlListSearchRequest
Search request for IP ACLs .
IPAccessControlListSearchResponse
@author Brett Guy
IssueResponse
@author Daniel DeGroff
JSONWebKey
A JSON Web Key as defined by RFC 7517 JSON Web Key (JWK) Section 4 and RFC 7518 JSON Web Algorithms (JWA).
JSONWebKeyInfoProvider
Interface for any object that can provide JSON Web key Information.
JWKSResponse
@author Daniel DeGroff
JWT
JSON Web Token (JWT) as defined by RFC 7519.
JWTConfiguration
JWT Configuration. A JWT Configuration for an Application may not be active if it is using the global configuration, the configuration may be enabled = false.
JWTPublicKeyUpdateEvent
Models the JWT public key Refresh Token Revoke Event. This event might be for a single token, a user or an entire application.
JWTRefreshEvent
Models the JWT Refresh Event. This event will be fired when a JWT is "refreshed" (generated) using a Refresh Token.
JWTRefreshResponse
API response for refreshing a JWT with a Refresh Token.
JWTRefreshTokenRevokeEvent
Models the Refresh Token Revoke Event. This event might be for a single token, a user or an entire application.
JWTVendRequest
@author Daniel DeGroff
JWTVendResponse
@author Daniel DeGroff
KafkaConfiguration
@author Daniel DeGroff
KafkaMessengerConfiguration
@author Brett Guy
Key
Domain for a public key, key pair or an HMAC secret. This is used by KeyMaster to manage keys for JWTs, SAML, etc.
KeyRequest
Key API request object.
KeyResponse
Key API response object.
KeySearchCriteria
Search criteria for Keys
KeySearchRequest
Search request for Keys
KeySearchResponse
Key search response
KickstartSuccessEvent
Event to indicate kickstart has been successfully completed.
Lambda
A JavaScript lambda function that is executed during certain events inside FusionAuth.
LambdaRequest
Lambda API request object.
LambdaResponse
Lambda API response object.
LambdaSearchCriteria
Search criteria for Lambdas
LambdaSearchRequest
Search request for Lambdas
LambdaSearchResponse
Lambda search response
LDAPConnectorConfiguration
Models an LDAP connector.
LinkedInApplicationConfiguration
@author Daniel DeGroff
LinkedInIdentityProvider
@author Daniel DeGroff
Location
Location information. Useful for IP addresses and other displayable data objects.
LogHistory
A historical state of a user log event. Since events can be modified, this stores the historical state.
LoginConfiguration
LoginHintConfiguration
@author Daniel DeGroff
LoginPingRequest
Login Ping API request object.
LoginPreventedResponse
The summary of the action that is preventing login to be returned on the login response.
LoginRecordConfiguration
LoginRecordExportRequest
@author Daniel DeGroff
LoginRecordSearchCriteria
@author Daniel DeGroff
LoginRecordSearchRequest
@author Daniel DeGroff
LoginRecordSearchResponse
A raw login record response
LoginReportResponse
Response for the login report.
LoginRequest
Login API request object.
LoginResponse
@author Brian Pontarelli
LogoutRequest
Request for the Logout API that can be used as an alternative to URL parameters.
LookupResponse
@author Daniel DeGroff
ManagedFields
This class contains the managed fields that are also put into the database during FusionAuth setup.
MaximumPasswordAge
@author Daniel DeGroff
MemberDeleteRequest
Group Member Delete Request
MemberRequest
Group Member Request
MemberResponse
Group Member Response
Message
@author Mikey Sleevi
MessageTemplate
Stores an message template used to distribute messages;
MessageTemplateRequest
A Message Template Request to the API
MessageTemplateResponse
@author Michael Sleevi
MessengerRequest
@author Brett Guy
MessengerResponse
@author Brett Guy
MessengerTransport
@author Daniel DeGroff
MetaData
MinimumPasswordAge
@author Daniel DeGroff
MonthlyActiveUserReportResponse
Response for the daily active user report.
MultiFactorAuthenticatorMethod
MultiFactorEmailMethod
MultiFactorEmailTemplate
MultiFactorSMSMethod
MultiFactorSMSTemplate
NintendoApplicationConfiguration
@author Brett Pontarelli
NintendoIdentityProvider
Nintendo gaming login provider.
NonTransactionalEvent
A marker interface indicating this event cannot be made transactional.
OAuth2Configuration
@author Daniel DeGroff
OAuthConfigurationResponse
@author Daniel DeGroff
OAuthError
@author Daniel DeGroff
OAuthResponse
@author Daniel DeGroff
OpenIdConfiguration
OpenID Connect Configuration as described by the OpenID Provider Metadata.
OpenIdConnectApplicationConfiguration
@author Daniel DeGroff
OpenIdConnectIdentityProvider
@author Daniel DeGroff
PasswordBreachDetection
@author Daniel DeGroff
PasswordEncryptionConfiguration
Password Encryption Scheme Configuration
PasswordlessConfiguration
PasswordlessIdentityProvider
Interface for all identity providers that are passwordless and do not accept a password.
PasswordlessLoginRequest
@author Daniel DeGroff
PasswordlessSendRequest
@author Daniel DeGroff
PasswordlessStartRequest
@author Daniel DeGroff
PasswordlessStartResponse
@author Daniel DeGroff
PasswordValidationRules
@author Derek Klatt
PasswordValidationRulesResponse
@author Daniel DeGroff
@author Daniel DeGroff
PendingResponse
@author Brian Pontarelli
PreviewMessageTemplateRequest
@author Michael Sleevi
PreviewMessageTemplateResponse
@author Michael Sleevi
PreviewRequest
@author Brian Pontarelli
PreviewResponse
@author Seth Musselman
PublicKeyCredentialCreationOptions
Allows the Relying Party to specify desired attributes of a new credential.
PublicKeyCredentialDescriptor
Contains attributes for the Relying Party to refer to an existing public key credential as an input parameter.
PublicKeyCredentialEntity
Describes a user account or WebAuthn Relying Party associated with a public key credential
PublicKeyCredentialParameters
Supply information on credential type and algorithm to the authenticator.
PublicKeyCredentialRelyingPartyEntity
Supply additional information about the Relying Party when creating a new credential
PublicKeyCredentialRequestOptions
Provides the authenticator with the data it needs to generate an assertion.
PublicKeyCredentialUserEntity
Supply additional information about the user account when creating a new credential
PublicKeyResponse
JWT Public Key Response Object
RateLimitedRequestConfiguration
@author Daniel DeGroff
RawLogin
Raw login information for each time a user logs into an application.
ReactorMetrics
@author Daniel DeGroff
ReactorMetricsResponse
@author Daniel DeGroff
ReactorRequest
Request for managing FusionAuth Reactor and licenses.
ReactorResponse
@author Daniel DeGroff
ReactorStatus
@author Daniel DeGroff
RecentLoginResponse
Response for the user login report.
RefreshRequest
@author Daniel DeGroff
RefreshResponse
@author Daniel DeGroff
RefreshToken
Models a JWT Refresh Token.
RefreshTokenImportRequest
Refresh Token Import request.
RefreshTokenResponse
API response for retrieving Refresh Tokens
RefreshTokenRevocationPolicy
@author Daniel DeGroff
RefreshTokenRevokeRequest
Request for the Refresh Token API to revoke a refresh token rather than using the URL parameters.
RefreshTokenSlidingWindowConfiguration
@author Daniel DeGroff
RegistrationConfiguration
RegistrationDeleteRequest
Registration delete API request object.
RegistrationReportResponse
Response for the registration report.
RegistrationRequest
Registration API request object.
RegistrationResponse
Registration API request object.
RegistrationUnverifiedOptions
@author Daniel DeGroff
ReindexRequest
Reindex API request
ReloadRequest
@author Daniel DeGroff
RememberPreviousPasswords
@author Daniel DeGroff
Requirable
Something that can be required and thus also optional. This currently extends Enableable because anything that is require/optional is almost always enableable as well.
RequiresCORSConfiguration
Interface describing the need for CORS configuration.
SAMLv2ApplicationConfiguration
@author Brian Pontarelli
SAMLv2AssertionConfiguration
@author Lyle Schemmerling
SAMLv2AssertionEncryptionConfiguration
SAMLv2Configuration
SAMLv2DestinationAssertionConfiguration
@author Lyle Schemmerling
SAMLv2IdentityProvider
SAML v2 identity provider configuration.
SAMLv2IdPInitiatedApplicationConfiguration
@author Daniel DeGroff
SAMLv2IdpInitiatedConfiguration
Config for regular SAML IDP configurations that support IdP initiated requests
SAMLv2IdPInitiatedIdentityProvider
SAML v2 IdP Initiated identity provider configuration.
SAMLv2IdPInitiatedLoginConfiguration
IdP Initiated login configuration
SAMLv2Logout
SAMLv2SingleLogout
SearchRequest
Search API request.
SearchResponse
Search API response.
SecretResponse
@author Daniel DeGroff
SecureGeneratorConfiguration
@author Daniel DeGroff
SecureIdentity
@author Daniel DeGroff
SelfServiceFormConfiguration
@author andrewpai
SendRequest
@author Daniel DeGroff
SendResponse
@author Daniel DeGroff
SMSMessage
@author Michael Sleevi
SMSMessageTemplate
@author Michael Sleevi
SonyPSNApplicationConfiguration
@author Brett Pontarelli
SonyPSNIdentityProvider
SonyPSN gaming login provider.
SortField
@author Daniel DeGroff
SteamApplicationConfiguration
@author Brett Pontarelli
SteamIdentityProvider
Steam gaming login provider.
SupportsPostBindings
Helper interface that indicates an identity provider can be federated to using the HTTP POST method.
SystemConfiguration
@author Brian Pontarelli
SystemConfigurationRequest
Request for the system configuration API.
SystemConfigurationResponse
Response for the system configuration API.
SystemLogsExportRequest
@author Daniel DeGroff
Templates
Tenant
@author Daniel DeGroff
Tenantable
@author Brian Pontarelli
TenantAccessControlConfiguration
@author Brett Guy
TenantCaptchaConfiguration
@author Brett Pontarelli
TenantDeleteRequest
Request for the Tenant API to delete a tenant rather than using the URL parameters.
TenantFormConfiguration
@author Daniel DeGroff
TenantLambdaConfiguration
@author Rob Davis
TenantLoginConfiguration
@author Daniel DeGroff
TenantMultiFactorConfiguration
@author Mikey Sleevi
TenantOAuth2Configuration
TenantRateLimitConfiguration
@author Daniel DeGroff
TenantRegistrationConfiguration
@author Daniel DeGroff
TenantRequest
@author Daniel DeGroff
TenantResponse
@author Daniel DeGroff
TenantSCIMServerConfiguration
@author Rob Davis
TenantSearchCriteria
Search criteria for Tenants
TenantSearchRequest
Search request for Tenants
TenantSearchResponse
Tenant search response
TenantSSOConfiguration
@author Brett Pontarelli
TenantUnverifiedConfiguration
@author Daniel DeGroff
TenantUserDeletePolicy
A Tenant-level policy for deleting Users.
TenantUsernameConfiguration
@author Daniel DeGroff
TenantWebAuthnConfiguration
Tenant-level configuration for WebAuthn
TenantWebAuthnWorkflowConfiguration
@author Spencer Witt
TestEvent
@author Daniel DeGroff
Theme
@author Trevor Smith
ThemeRequest
Theme API request object.
ThemeResponse
Theme API response object.
ThemeSearchCriteria
Search criteria for themes
ThemeSearchRequest
Search request for Themes.
ThemeSearchResponse
Search response for Themes
TimeBasedDeletePolicy
A policy for deleting Users based upon some external criteria.
Totals
TotalsReportResponse
The response from the total report. This report stores the total numbers for each application.
TwilioMessengerConfiguration
@author Brett Guy
TwitchApplicationConfiguration
@author Brett Pontarelli
TwitchIdentityProvider
Twitch gaming login provider.
TwitterApplicationConfiguration
@author Daniel DeGroff
TwitterIdentityProvider
Twitter social login provider.
TwoFactorDisableRequest
@author Brian Pontarelli
TwoFactorEnableDisableSendRequest
@author Daniel DeGroff
TwoFactorLoginRequest
@author Daniel DeGroff
TwoFactorMethod
@author Daniel DeGroff
TwoFactorRecoveryCodeResponse
@author Daniel DeGroff
TwoFactorRequest
@author Brian Pontarelli
TwoFactorResponse
@author Daniel DeGroff
TwoFactorSendRequest
@author Daniel DeGroff
TwoFactorStartRequest
@author Brett Guy
TwoFactorStartResponse
@author Daniel DeGroff
TwoFactorStatusResponse
@author Daniel DeGroff
TwoFactorTrust
UIConfiguration
UniqueUsernameConfiguration
User
The global view of a User. This object contains all global information about the user including birth date, registration information preferred languages, global attributes, etc.
UserAction
An action that can be executed on a user (discipline or reward potentially).
UserActionEvent
Models the user action Event.
UserActionLog
A log for an action that was taken on a User.
UserActionOption
Models content user action options.
UserActionReason
Models action reasons.
UserActionReasonRequest
User Action Reason API request object.
UserActionReasonResponse
User Action Reason API response object.
UserActionRequest
User Action API request object.
UserActionResponse
User Action API response object.
UserBulkCreateEvent
Models the User Bulk Create Event.
UserComment
A log for an event that happened to a User.
UserCommentRequest
@author Seth Musselman
UserCommentResponse
User Comment Response
UserCommentSearchCriteria
Search criteria for user comments.
UserCommentSearchRequest
Search request for user comments
UserCommentSearchResponse
User comment search response
UserConsent
Models a User consent.
UserConsentRequest
API response for User consent.
UserConsentResponse
API response for User consent.
UserCreateCompleteEvent
Models the User Created Event.
UserCreateEvent
Models the User Create Event.
UserDeactivateEvent
Models the User Deactivate Event.
UserDeleteCompleteEvent
Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update, delete).
UserDeleteEvent
Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update, delete).
UserDeleteRequest
User API delete request object.
UserDeleteResponse
User API bulk response object.
UserDeleteSingleRequest
User API delete request object for a single user.
UserEmailUpdateEvent
Models an event where a user's email is updated outside of a forgot / change password workflow.
UserEmailVerifiedEvent
Models the User Email Verify Event.
UserIdentityProviderLinkEvent
Models the User Identity Provider Link Event.
UserIdentityProviderUnlinkEvent
Models the User Identity Provider Unlink Event.
UserLoginFailedEvent
Models the User Login Failed Event.
UserLoginIdDuplicateOnCreateEvent
Models an event where a user is being created with an "in-use" login Id (email or username).
UserLoginIdDuplicateOnUpdateEvent
Models an event where a user is being updated and tries to use an "in-use" login Id (email or username).
UserLoginNewDeviceEvent
Models the User Login event for a new device (un-recognized)
UserLoginSuccessEvent
Models the User Login Success Event.
UserLoginSuspiciousEvent
Models the User Login event that is suspicious.
UsernameModeration
UserPasswordBreachEvent
Models the User Password Breach Event.
UserPasswordResetSendEvent
Models the User Password Reset Send Event.
UserPasswordResetStartEvent
Models the User Password Reset Start Event.
UserPasswordResetSuccessEvent
Models the User Password Reset Success Event.
UserPasswordUpdateEvent
Models the User Password Update Event.
UserReactivateEvent
Models the User Reactivate Event.
UserRegistration
User registration information for a single application.
UserRegistrationCreateCompleteEvent
Models the User Created Registration Event.
UserRegistrationCreateEvent
Models the User Create Registration Event.
UserRegistrationDeleteCompleteEvent
Models the User Deleted Registration Event.
UserRegistrationDeleteEvent
Models the User Delete Registration Event.
UserRegistrationUpdateCompleteEvent
Models the User Update Registration Event.
UserRegistrationUpdateEvent
Models the User Update Registration Event.
UserRegistrationVerifiedEvent
Models the User Registration Verified Event.
UserRequest
User API request object.
UserResponse
User API response object.
UserSearchCriteria
This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
UserTwoFactorConfiguration
@author Daniel DeGroff
UserTwoFactorMethodAddEvent
Model a user event when a two-factor method has been removed.
UserTwoFactorMethodRemoveEvent
Model a user event when a two-factor method has been added.
UserUpdateCompleteEvent
Models the User Update Event once it is completed. This cannot be transactional.
UserUpdateEvent
Models the User Update Event.
ValidateResponse
@author Daniel DeGroff
VerifyEmailRequest
@author Daniel DeGroff
VerifyEmailResponse
@author Daniel DeGroff
VerifyRegistrationRequest
@author Daniel DeGroff
VerifyRegistrationResponse
@author Daniel DeGroff
VersionResponse
@author Daniel DeGroff
WebAuthnAssertResponse
API response for completing WebAuthn assertion
WebAuthnAuthenticatorAuthenticationResponse
The authenticator's response for the authentication ceremony in its encoded format
WebAuthnAuthenticatorRegistrationResponse
The authenticator's response for the registration ceremony in its encoded format
WebAuthnCredential
A User's WebAuthnCredential. Contains all data required to complete WebAuthn authentication ceremonies.
WebAuthnCredentialImportRequest
API request to import an existing WebAuthn credential(s)
WebAuthnCredentialResponse
WebAuthn Credential API response
WebAuthnExtensionsClientOutputs
Contains extension output for requested extensions during a WebAuthn ceremony
WebAuthnLoginRequest
Request to complete the WebAuthn registration ceremony
WebAuthnPublicKeyAuthenticationRequest
Request to authenticate with WebAuthn
WebAuthnPublicKeyRegistrationRequest
Request to register a new public key with WebAuthn
WebAuthnRegisterCompleteRequest
Request to complete the WebAuthn registration ceremony for a new credential,.
WebAuthnRegisterCompleteResponse
API response for completing WebAuthn credential registration or assertion
WebAuthnRegisterStartRequest
API request to start a WebAuthn registration ceremony
WebAuthnRegisterStartResponse
API response for starting a WebAuthn registration ceremony
WebAuthnRegistrationExtensionOptions
Options to request extensions during credential registration
WebAuthnStartRequest
API request to start a WebAuthn authentication ceremony
WebAuthnStartResponse
API response for starting a WebAuthn authentication ceremony
Webhook
A server where events are sent. This includes user action events and any other events sent by FusionAuth.
WebhookRequest
Webhook API request object.
WebhookResponse
Webhook API response object.
WebhookSearchCriteria
Search criteria for webhooks.
WebhookSearchRequest
Search request for webhooks
WebhookSearchResponse
Webhook search response
WebhookSignatureConfiguration
Configuration for signing webhooks.
XboxApplicationConfiguration
@author Brett Pontarelli
XboxIdentityProvider
Xbox gaming login provider.

Enums

Algorithm
Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation.
ApplicationMultiFactorTrustPolicy
@author Daniel DeGroff
AttestationConveyancePreference
Used to communicate whether and how authenticator attestation should be delivered to the Relying Party
AttestationType
Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
AuthenticationThreats
@author Brett Pontarelli
AuthenticatorAttachment
Describes the authenticator attachment modality.
AuthenticatorAttachmentPreference
Describes the authenticator attachment modality preference for a WebAuthn workflow. See {@link AuthenticatorAttachment}
BreachAction
BreachedPasswordStatus
@author Daniel DeGroff
BreachMatchMode
CanonicalizationMethod
XML canonicalization method enumeration. This is used for the IdP and SP side of FusionAuth SAML.
CaptchaMethod
@author Brett Pontarelli
ChangePasswordReason
@author Trevor Smith
ClientAuthenticationMethod
ClientAuthenticationPolicy
@author Brett Guy
ConnectorType
The types of connectors. This enum is stored as an ordinal on the identities table, order must be maintained.
ConsentStatus
Models a consent.
ContentStatus
Status for content like usernames, profile attributes, etc.
CoseAlgorithmIdentifier
A number identifying a cryptographic algorithm. Values should be registered with the IANA COSE Algorithms registry
CoseEllipticCurve
COSE Elliptic Curve identifier to determine which elliptic curve to use with a given key
CoseKeyType
COSE key type
DeviceType
EmailSecurityType
EventLogType
Event Log Type
EventType
Models the event types that FusionAuth produces.
ExpiryUnit
@author Brian Pontarelli
FamilyRole
FormControl
@author Daniel DeGroff
FormDataType
@author Daniel DeGroff
FormFieldAdminPolicy
@author Daniel DeGroff
FormType
@author Daniel DeGroff
GrantType
Authorization Grant types as defined by the The OAuth 2.0 Authorization Framework - RFC 6749.
HTTPMethod
@author Daniel DeGroff
IdentityProviderLinkingStrategy
The IdP behavior when no user link has been made yet.
IdentityProviderLoginMethod
@author Brett Pontarelli
IdentityProviderType
@author Daniel DeGroff
IPAccessControlEntryAction
@author Brett Guy
KeyAlgorithm
KeyType
KeyUse
The use type of a key.
LambdaEngineType
@author Daniel DeGroff
LambdaType
The types of lambdas that indicate how they are invoked by FusionAuth.
LDAPSecurityMethod
LoginIdType
LogoutBehavior
@author Matthew Altman
MessageType
@author Mikey Sleevi
MessengerType
@author Brett Guy
MultiFactorLoginPolicy
@author Daniel DeGroff
Oauth2AuthorizedURLValidationPolicy
@author Johnathon Wood
OAuthErrorReason
OAuthErrorType
ObjectState
@author Daniel DeGroff
ProofKeyForCodeExchangePolicy
@author Brett Guy
PublicKeyCredentialType
Defines valid credential types. This is an extension point in the WebAuthn spec. The only defined value at this time is "public-key"
RateLimitedRequestType
@author Daniel DeGroff
ReactorFeatureStatus
@author Brian Pontarelli
RefreshTokenExpirationPolicy
@author Daniel DeGroff
RefreshTokenUsagePolicy
@author Daniel DeGroff
RegistrationType
ResidentKeyRequirement
Describes the Relying Party's requirements for client-side discoverable credentials (formerly known as "resident keys")
SAMLLogoutBehavior
SAMLv2DestinationAssertionPolicy
@author Lyle Schemmerling
SecureGeneratorType
@author Daniel DeGroff
Sort
@author Daniel DeGroff
SteamAPIMode
Steam API modes.
TokenType
  • Bearer Token type as defined by RFC 6750.
  • MAC Token type as referenced by RFC 6749 and Draft RFC on OAuth 2.0 Message Authentication Code (MAC) Tokens
    • TOTPAlgorithm
    TransactionType
    The transaction types for Webhooks and other event systems within FusionAuth.
    UniqueUsernameStrategy
    UnverifiedBehavior
    @author Daniel DeGroff
    UserActionPhase
    The phases of a time-based user action.
    UserState
    @author Daniel DeGroff
    UserVerificationRequirement
    Used to express whether the Relying Party requires user verification for the current operation.
    VerificationStrategy
    @author Daniel DeGroff
    WebAuthnWorkflow
    Identifies the WebAuthn workflow. This will affect the parameters used for credential creation and request based on the Tenant configuration.
    XMLSignatureLocation

    Functions

    defaultErrorResponseHandlerBuilder<RT, ERT>(FromJsonMethod fromJson) → ResponseHandler<RT, ERT>
    DefaultFusionAuthRESTClientFactory<ReturnType, ErrorReturnType>(dynamic host, dynamic httpClient) → FusionAuthRESTClient<ReturnType, ErrorReturnType>
    defaultResponseHandlerBuilder<RT, ERT>(FromJsonMethod fromJson) → ResponseHandler<RT, ERT>

    Typedefs

    FromJsonMethod<RT> = RT Function(dynamic)
    ResponseHandler<RT, ERT> = Future<void> Function(HttpClientResponse, ClientResponse<RT, ERT>)
    RESTClientFactory = FusionAuthRESTClient Function<ReturnType, ErrorReturnType>(String host, HttpClient httpClient)