package
0.0.0-20250306234804-548642b6b786
Repository: https://github.com/fusionauth/go-client.git
Documentation: pkg.go.dev
# Functions
NewClient creates a new FusionAuthClient if httpClient is nil then a DefaultClient is used.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* The user action request object.
*
* The user action response object.
*
* domain POJO to represent AuthenticationKey
*
* @author sanjay
*/.
No description provided by the author
No description provided by the author
*
* Authentication key request object.
*
* Authentication key response object.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Seth Musselman
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* A custom OAuth scope for a specific application.
*
* The Application Scope API request object.
*
* The Application Scope API response.
*
* A Application-level policy for deleting Users.
*
* The Application API request object.
*
* The Application API response.
*
* A role given to a user for a specific application.
*
* Search criteria for Applications
*
* @author Spencer Witt
*/.
*
* Search request for Applications
*
* @author Spencer Witt
*/.
*
* Application search response
*
* @author Spencer Witt
*/.
*
* Application-level configuration for WebAuthn
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* This class is a simple attachment with a byte array, name and MIME type.
*
* An audit log.
No description provided by the author
*
* Event to indicate an audit log was created.
*
* @author Daniel DeGroff
*/.
*
* @author Brian Pontarelli
*/.
*
* Audit log response.
*
* @author Brian Pontarelli
*/.
*
* @author Brian Pontarelli
*/.
*
* Audit log response.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* Used by the Relying Party to specify their requirements for authenticator attributes.
Do not require a setter for 'type', it is defined by the concrete class and is not mutable.
*
* @author Brian Pontarelli
*/.
*
* Base class for all FusionAuth events.
*
* Base class for requests that can contain event information.
*
* @author Daniel DeGroff
*/.
*
* Base class for all {@link Group} and {@link GroupMember} events.
*
* Base Response which contains the HTTP status code
*
* @author Matthew Altman
*/.
Do not require a setter for 'type', it is defined by the concrete class and is not mutable.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
Do not require a setter for 'type', it is defined by the concrete class and is not mutable.
*
* @author Lyle Schemmerling
*/.
*
* @author Brian Pontarelli
*/.
*
* Base class for all {@link User}-related events.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* Change password request object.
*
* Change password response object.
*
* CleanSpeak configuration at the system and application level.
No description provided by the author
*
* @author Trevor Smith
*/.
*
* @author Trevor Smith
*/.
*
* @author Trevor Smith
*/.
*
* Models a consent.
*
* API request for User consent types.
*
* API response for consent.
*
* Search criteria for Consents
*
* @author Spencer Witt
*/.
*
* Search request for Consents
*
* @author Spencer Witt
*/.
*
* Consent search response
*
* @author Spencer Witt
*/.
*
* @author Trevor Smith
*/.
*
* @author Brian Pontarelli
*/.
*
* Contains the output for the {@code credProps} extension
*
* @author Spencer Witt
*/.
*
* Response for the daily active user report.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Trevor Smith
*/.
*
* @author Daniel DeGroff
*/.
*
* A displayable raw login that includes application name and user loginId.
*
* Interface for all identity providers that can be domain based.
*
* This class is an abstraction of a simple email message.
*
* An email address.
*
* @author Brian Pontarelli
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* Stores an email template used to send emails to users.
No description provided by the author
*
* Email template request.
*
* Email template response.
*
* Search criteria for Email templates
*
* @author Mark Manes
*/.
*
* Search request for email templates
*
* @author Mark Manes
*/.
*
* Email template search response
*
* @author Mark Manes
*/.
*
* @author Daniel DeGroff
*/.
*
* Something that can be enabled and thus also disabled.
*
* Models an entity that a user can be granted permissions to.
*
* A grant for an entity to a user or another entity.
*
* Entity grant API request object.
*
* Entity grant API response object.
*
* Search criteria for entity grants.
*
* Search request for entity grants.
*
* Search request for entity grants.
*
* JWT Configuration for entities.
*
* Entity API request object.
*
* Entity API response object.
*
* This class is the entity query.
*
* Search request for entities
*
* @author Brett Guy
*/.
*
* Search request for entities
*
* @author Brett Guy
*/.
*
* Models an entity type that has a specific set of permissions.
*
* Models a specific entity type permission.
*
* Entity Type API request object.
*
* Entity Type API response object.
*
* Search criteria for entity types.
*
* Search request for entity types.
*
* Search response for entity types.
*
* @author Brett Pontarelli
*/.
*
* Epic gaming login provider.
*
* Defines an error.
*
* Standard error domain object that can also be used as the response from an API call.
*
* @author Brian Pontarelli
*/.
No description provided by the author
*
* Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
*
* Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc.
No description provided by the author
*
* An Event "event" to indicate an event log was created.
*
* Event log response.
*
* Search criteria for the event log.
*
* @author Brian Pontarelli
*/.
*
* Event log response.
*
* Container for the event information.
*
* An expandable API request.
*
* An expandable API response.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* External JWT-only identity provider.
*
* @author Daniel DeGroff
*/.
*
* Facebook social login provider.
*
* A policy to configure if and when the user-action is canceled prior to the expiration of the action.
*
* Configuration for the behavior of failed login attempts.
*
* Models a family grouping of users.
*
* @author Brian Pontarelli
*/.
*
* API request for sending out family requests to parent's.
*
* Models a single family member.
*
* API request for managing families and members.
*
* API response for managing families and members.
*
* Forgot password request object.
*
* Forgot password response object.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* The FormField API request object.
*
* Form field response.
*
* @author Daniel DeGroff
*/.
*
* Form response.
*
* Form response.
*
* @author Daniel DeGroff
*/.
FusionAuthClient describes the Go Client for interacting with FusionAuth's RESTful API.
*
* Models the FusionAuth connector.
*
* Models a generic connector.
*
* @author Brett Guy
*/.
*
* @author Daniel DeGroff
*/.
*
* Google social login provider.
*
* Google social login provider parameters.
*
* @author Tyler Scott
*/.
*
* Models the Group Created Event.
*
* Models the Group Create Event.
*
* Models the Group Create Complete Event.
*
* Models the Group Delete Event.
*
* A User's membership into a Group
*
* @author Daniel DeGroff
*/.
*
* Models the Group Member Add Complete Event.
*
* Models the Group Member Add Event.
*
* Models the Group Member Remove Complete Event.
*
* Models the Group Member Remove Event.
*
* Search criteria for Group Members
*
* @author Daniel DeGroff
*/.
*
* Search request for Group Members.
*
* Search response for Group Members
*
* @author Daniel DeGroff
*/.
*
* Models the Group Member Update Complete Event.
*
* Models the Group Member Update Event.
*
* Group API request object.
*
* Group API response object.
*
* Search criteria for Groups
*
* @author Daniel DeGroff
*/.
*
* Search request for Groups.
*
* Search response for Groups
*
* @author Daniel DeGroff
*/.
*
* Models the Group Update Complete Event.
*
* Models the Group Update Event.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Login API request object used for login to third-party systems (i.e.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Search criteria for Identity Providers.
*
* Search request for Identity Providers
*
* @author Spencer Witt
*/.
*
* Identity Provider response.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Import request.
*
* A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks.
*
* The Integration Request
*
* @author Daniel DeGroff
*/.
*
* The Integration Response
*
* @author Daniel DeGroff
*/.
*
* Available Integrations
*
* @author Daniel DeGroff
*/.
*
* @author Brett Guy
*/.
*
* @author Brett Guy
*/.
*
* @author Brett Guy
*/.
*
* @author Brett Guy
*/.
*
* @author Brett Guy
*/.
*
* Search request for IP ACLs .
*
* @author Brett Guy
*/.
*
* @author Daniel DeGroff
*/.
*
* A JSON Web Key as defined by <a href="https://tools.ietf.org/html/rfc7517#section-4">RFC 7517 JSON Web Key (JWK)
* Section 4</a> and <a href="https://tools.ietf.org/html/rfc7518">RFC 7518 JSON Web Algorithms (JWA)</a>.
*
* Interface for any object that can provide JSON Web key Information.
*
* @author Daniel DeGroff
*/.
*
* JSON Web Token (JWT) as defined by RFC 7519.
*
* JWT Configuration.
*
* Models the JWT public key Refresh Token Revoke Event.
*
* Models the JWT Refresh Event.
*
* API response for refreshing a JWT with a Refresh Token.
*
* Models the Refresh Token Revoke Event.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Brett Guy
*/.
*
* Domain for a public key, key pair or an HMAC secret.
*
* Key API request object.
*
* Key API response object.
*
* Search criteria for Keys
*
* @author Spencer Witt
*/.
*
* Search request for Keys
*
* @author Spencer Witt
*/.
*
* Key search response
*
* @author Spencer Witt
*/.
*
* Event to indicate kickstart has been successfully completed.
*
* A JavaScript lambda function that is executed during certain events inside FusionAuth.
No description provided by the author
*
* Lambda API request object.
*
* Lambda API response object.
*
* Search criteria for Lambdas
*
* @author Mark Manes
*/.
*
* Search request for Lambdas
*
* @author Mark Manes
*/.
*
* Lambda search response
*
* @author Mark Manes
*/.
*
* Models an LDAP connector.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Location information.
*
* A historical state of a user log event.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* Login Ping API request object.
*
* The summary of the action that is preventing login to be returned on the login response.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* A raw login record response
*
* @author Daniel DeGroff
*/.
*
* Response for the login report.
*
* Login API request object.
*
* @author Brian Pontarelli
*/.
*
* Request for the Logout API that can be used as an alternative to URL parameters.
*
* @author Daniel DeGroff
*/.
*
* This class contains the managed fields that are also put into the database during FusionAuth setup.
*
* @author Daniel DeGroff
*/.
*
* Group Member Delete Request
*
* @author Daniel DeGroff
*/.
*
* Group Member Request
*
* @author Daniel DeGroff
*/.
*
* Group Member Response
*
* @author Daniel DeGroff
*/.
*
* @author Mikey Sleevi
*/.
*
* Stores an message template used to distribute messages;
*
* @author Michael Sleevi
*/.
*
* A Message Template Request to the API
*
* @author Michael Sleevi
*/.
*
* @author Michael Sleevi
*/.
*
* @author Brett Guy
*/.
*
* @author Brett Guy
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* Response for the daily active user report.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*
* @author Brett Pontarelli
*/.
*
* Nintendo gaming login provider.
*
* A marker interface indicating this event cannot be made transactional.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* A marker interface indicating this event is an event that can supply a linked object Id.
*
* OpenID Connect Configuration as described by the <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata">OpenID
* Provider Metadata</a>.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Password Encryption Scheme Configuration
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* Interface for all identity providers that are passwordless and do not accept a password.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Derek Klatt
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Brian Pontarelli
*/.
*
* @author Michael Sleevi
*/.
*
* @author Michael Sleevi
*/.
*
* @author Brian Pontarelli
*/.
*
* @author Seth Musselman
*/.
*
* The handling policy for scopes provided by FusionAuth
*
* @author Spencer Witt
*/.
No description provided by the author
*
* Allows the Relying Party to specify desired attributes of a new credential.
*
* Contains attributes for the Relying Party to refer to an existing public key credential as an input parameter.
*
* Describes a user account or WebAuthn Relying Party associated with a public key credential
*/.
*
* Supply information on credential type and algorithm to the <i>authenticator</i>.
*
* Supply additional information about the Relying Party when creating a new credential
*
* @author Spencer Witt
*/.
*
* Provides the <i>authenticator</i> with the data it needs to generate an assertion.
*
* Supply additional information about the user account when creating a new credential
*
* @author Spencer Witt
*/.
*
* JWT Public Key Response Object
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Raw login information for each time a user logs into an application.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Request for managing FusionAuth Reactor and licenses.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Response for the user login report.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Models a JWT Refresh Token.
*
* Refresh Token Import request.
*
* Refresh token one-time use configuration.
*
* API response for retrieving Refresh Tokens
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Request for the Refresh Token API to revoke a refresh token rather than using the URL parameters.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* Registration delete API request object.
*
* Response for the registration report.
*
* Registration API request object.
*
* Registration API request object.
*
* @author Daniel DeGroff
*/.
*
* Reindex API request
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Something that can be required and thus also optional.
*
* Interface describing the need for CORS configuration.
*
* @author Brian Pontarelli
*/.
*
* @author Lyle Schemmerling
*/.
*
* Configuration for encrypted assertions when acting as SAML Service Provider
*
* @author Jaret Hendrickson
*/.
No description provided by the author
No description provided by the author
*
* @author Lyle Schemmerling
*/.
*
* SAML v2 identity provider configuration.
*
* @author Daniel DeGroff
*/.
*
* Config for regular SAML IDP configurations that support IdP initiated requests
*
* @author Lyle Schemmerling
*/.
*
* SAML v2 IdP Initiated identity provider configuration.
*
* IdP Initiated login configuration
*
* @author Daniel DeGroff
*/.
No description provided by the author
No description provided by the author
*
* Search API request.
*
* Search API response.
*
* Search results.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author andrewpai
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Theme object for values used in the css variables for simple themes.
*
* @author Michael Sleevi
*/.
*
* @author Michael Sleevi
*/.
*
* @author Brett Pontarelli
*/.
*
* SonyPSN gaming login provider.
*
* @author Daniel DeGroff
*/.
*
* The public Status API response
*
* @author Daniel DeGroff
*/.
*
* @author Brett Pontarelli
*/.
*
* Steam gaming login provider.
*
* Helper interface that indicates an identity provider can be federated to using the HTTP POST method.
*
* @author Brian Pontarelli
*/.
*
* Request for the system configuration API.
*
* Response for the system configuration API.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Brian Pontarelli
*/.
*
* @author Brett Guy
*/.
*
* @author Brett Pontarelli
*/.
*
* Request for the Tenant API to delete a tenant rather than using the URL parameters.
*
* @author Daniel DeGroff
*/.
*
* @author Rob Davis
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Mikey Sleevi
*/.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Rob Davis
*/.
*
* Search criteria for Tenants
*
* @author Mark Manes
*/.
*
* Search request for Tenants
*
* @author Mark Manes
*/.
*
* Tenant search response
*
* @author Mark Manes
*/.
*
* @author Brett Pontarelli
*/.
*
* @author Daniel DeGroff
*/.
*
* A Tenant-level policy for deleting Users.
*
* @author Daniel DeGroff
*/.
*
* Tenant-level configuration for WebAuthn
*
* @author Spencer Witt
*/.
*
* @author Spencer Witt
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Trevor Smith
*/.
*
* Theme API request object.
*
* Theme API response object.
*
* Search criteria for themes
*
* @author Mark Manes
*/.
*
* Search request for Themes.
*
* Search response for Themes
*
* @author Mark Manes
*/.
*
* A policy for deleting Users based upon some external criteria.
No description provided by the author
*
* The response from the total report.
*
* @author Brett Guy
*/.
*
* @author Brett Pontarelli
*/.
*
* Twitch gaming login provider.
*
* @author Daniel DeGroff
*/.
*
* Twitter social login provider.
*
* @author Brian Pontarelli
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Brian Pontarelli
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Brett Guy
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
No description provided by the author
No description provided by the author
*
* Config for Usage Data / Stats
*
* @author Lyle Schemmerling
*/.
*
* The global view of a User.
*
* An action that can be executed on a user (discipline or reward potentially).
*
* Models the user action Event.
*
* A log for an action that was taken on a User.
*
* Models content user action options.
*
* Models action reasons.
*
* User Action Reason API request object.
*
* User Action Reason API response object.
*
* User Action API request object.
*
* User Action API response object.
*
* Models the User Bulk Create Event.
*
* A log for an event that happened to a User.
*
* @author Seth Musselman
*/.
*
* User Comment Response
*
* @author Seth Musselman
*/.
*
* Search criteria for user comments.
*
* Search request for user comments
*
* @author Spencer Witt
*/.
*
* User comment search response
*
* @author Spencer Witt
*/.
*
* Models a User consent.
*
* API response for User consent.
*
* API response for User consent.
*
* Models the User Created Event.
*
* Models the User Create Event.
*
* Models the User Deactivate Event.
*
* Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
* delete).
*
* Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
* delete).
*
* User API delete request object.
*
* User API bulk response object.
*
* User API delete request object for a single user.
*
* Models an event where a user's email is updated outside of a forgot / change password workflow.
*
* Models the User Email Verify Event.
*
* Models the User Identity Provider Link Event.
*
* Models the User Identity Provider Unlink Event.
*
* Models the User Login Failed Event.
*
* The reason for the login failure.
*
* User login failed reason codes.
*
* Models an event where a user is being created with an "in-use" login Id (email or username).
*
* Models an event where a user is being updated and tries to use an "in-use" login Id (email or username).
*
* Models the User Login event for a new device (un-recognized)
*
* @author Daniel DeGroff
*/.
*
* Models the User Login Success Event.
*
* Models the User Login event that is suspicious.
No description provided by the author
*
* Models the User Password Breach Event.
*
* Models the User Password Reset Send Event.
*
* Models the User Password Reset Start Event.
*
* Models the User Password Reset Success Event.
*
* Models the User Password Update Event.
*
* Models the User Reactivate Event.
*
* User registration information for a single application.
*
* Models the User Created Registration Event.
*
* Models the User Create Registration Event.
*
* Models the User Deleted Registration Event.
*
* Models the User Delete Registration Event.
*
* Models the User Update Registration Event.
*
* Models the User Update Registration Event.
*
* Models the User Registration Verified Event.
*
* User API request object.
*
* User API response object.
*
* This class is the user query.
*
* @author Daniel DeGroff
*/.
*
* Model a user event when a two-factor method has been removed.
*
* Model a user event when a two-factor method has been added.
*
* Models the User Update Event once it is completed.
*
* Models the User Update Event.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* API response for completing WebAuthn assertion
*
* @author Spencer Witt
*/.
*
* The <i>authenticator's</i> response for the authentication ceremony in its encoded format
*
* @author Spencer Witt
*/.
*
* The <i>authenticator's</i> response for the registration ceremony in its encoded format
*
* @author Spencer Witt
*/.
*
* A User's WebAuthnCredential.
*
* API request to import an existing WebAuthn credential(s)
*
* @author Spencer Witt
*/.
*
* WebAuthn Credential API response
*
* @author Spencer Witt
*/.
*
* Contains extension output for requested extensions during a WebAuthn ceremony
*
* @author Spencer Witt
*/.
*
* Request to complete the WebAuthn registration ceremony
*
* @author Spencer Witt
*/.
*
* Request to authenticate with WebAuthn
*
* @author Spencer Witt
*/.
*
* Request to register a new public key with WebAuthn
*
* @author Spencer Witt
*/.
*
* Request to complete the WebAuthn registration ceremony for a new credential,.
*
* API response for completing WebAuthn credential registration or assertion
*
* @author Spencer Witt
*/.
*
* API request to start a WebAuthn registration ceremony
*
* @author Spencer Witt
*/.
*
* API response for starting a WebAuthn registration ceremony
*
* @author Spencer Witt
*/.
*
* Options to request extensions during credential registration
*
* @author Spencer Witt
*/.
*
* API request to start a WebAuthn authentication ceremony
*
* @author Spencer Witt
*/.
*
* API response for starting a WebAuthn authentication ceremony
*
* @author Spencer Witt
*/.
*
* A server where events are sent.
*
* A webhook call attempt log.
*
* Webhook attempt log response.
*
* A webhook call response.
No description provided by the author
*
* The system configuration for Webhook Event Log data.
*
* Webhook event log response.
*
* Search criteria for the webhook event log.
*
* Webhook event log search request.
*
* Webhook event log search response.
*
* Webhook API request object.
*
* Webhook API response object.
*
* Search criteria for webhooks.
*
* Search request for webhooks
*
* @author Spencer Witt
*/.
*
* Webhook search response
*
* @author Spencer Witt
*/.
*
* Configuration for signing webhooks.
*
* @author Brett Pontarelli
*/.
*
* Xbox gaming login provider.
# Interfaces
No description provided by the author
# Type aliases
*
* Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation.
*
* @author Daniel DeGroff
*/.
*
* Used to communicate whether and how authenticator attestation should be delivered to the Relying Party
*
* @author Spencer Witt
*/.
*
* Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
*
* @author Spencer Witt
*/.
*
* @author Brett Pontarelli
*/.
*
* Describes the <a href="https://www.w3.org/TR/webauthn-2/#authenticator-attachment-modality">authenticator attachment modality</a>.
*
* Describes the authenticator attachment modality preference for a WebAuthn workflow.
No description provided by the author
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* XML canonicalization method enumeration.
*
* @author Brett Pontarelli
*/.
*
* @author Trevor Smith
*/.
No description provided by the author
*
* @author Brett Guy
*/.
*
* The types of connectors.
*
* Models a consent.
*
* Status for content like usernames, profile attributes, etc.
*
* A number identifying a cryptographic algorithm.
*
* COSE Elliptic Curve identifier to determine which elliptic curve to use with a given key
*
* @author Spencer Witt
*/.
*
* COSE key type
*
* @author Spencer Witt
*/.
No description provided by the author
No description provided by the author
*
* Event Log Type
*
* @author Daniel DeGroff
*/.
*
* Models the event types that FusionAuth produces.
*
* @author Brian Pontarelli
*/.
No description provided by the author
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">The OAuth 2.0 Authorization
* Framework - RFC 6749</a>.
*
* @author Daniel DeGroff
*/.
*
* The IdP behavior when no user link has been made yet.
*
* @author Brett Pontarelli
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Brett Guy
*/.
No description provided by the author
No description provided by the author
*
* The use type of a key.
*
* @author Daniel DeGroff
*/.
*
* The types of lambdas that indicate how they are invoked by FusionAuth.
No description provided by the author
No description provided by the author
No description provided by the author
*
* @author Matthew Altman
*/.
*
* @author Mikey Sleevi
*/.
*
* @author Brett Guy
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Johnathon Wood
*/.
*
* The application's relationship to the authorization server.
No description provided by the author
No description provided by the author
*
* Controls the policy for requesting user permission to grant access to requested scopes during an OAuth workflow
* for a third-party application.
*
* Controls the policy for whether OAuth workflows will more strictly adhere to the OAuth and OIDC specification
* or run in backwards compatibility mode.
*
* @author Daniel DeGroff
*/.
*
* @author Brett Guy
*/.
*
* Defines valid credential types.
*
* @author Daniel DeGroff
*/.
*
* @author Brian Pontarelli
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* Describes the Relying Party's requirements for <a href="https://www.w3.org/TR/webauthn-2/#client-side-discoverable-credential">client-side
* discoverable credentials</a> (formerly known as "resident keys")
*
* @author Spencer Witt
*/.
No description provided by the author
*
* @author Lyle Schemmerling
*/.
*
* @author Daniel DeGroff
*/.
*
* @author Daniel DeGroff
*/.
*
* Steam API modes.
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* <ul>
* <li>Bearer Token type as defined by <a href="https://tools.ietf.org/html/rfc6750">RFC 6750</a>.</li>
* <li>MAC Token type as referenced by <a href="https://tools.ietf.org/html/rfc6749">RFC 6749</a> and
* <a href="https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-05">
* Draft RFC on OAuth 2.0 Message Authentication Code (MAC) Tokens</a>
* </li>
* </ul>
*
* @author Daniel DeGroff
*/.
No description provided by the author
*
* The transaction types for Webhooks and other event systems within FusionAuth.
No description provided by the author
*
* Policy for handling unknown OAuth scopes in the request
*
* @author Spencer Witt
*/.
*
* @author Daniel DeGroff
*/.
*
* The phases of a time-based user action.
*
* @author Daniel DeGroff
*/.
*
* Used to express whether the Relying Party requires <a href="https://www.w3.org/TR/webauthn-2/#user-verification">user verification</a> for the
* current operation.
*
* @author Daniel DeGroff
*/.
*
* Identifies the WebAuthn workflow.
*
* The possible states of an individual webhook attempt to a single endpoint.
*
* The possible result states of a webhook event.
No description provided by the author