fusionauth

package
v0.0.0-...-a3bace2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 13, 2024 License: Apache-2.0 Imports: 12 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey

type APIKey struct {
	Id                    string            `json:"id,omitempty"`
	InsertInstant         int64             `json:"insertInstant,omitempty"`
	IpAccessControlListId string            `json:"ipAccessControlListId,omitempty"`
	Key                   string            `json:"key,omitempty"`
	KeyManager            bool              `json:"keyManager"`
	LastUpdateInstant     int64             `json:"lastUpdateInstant,omitempty"`
	MetaData              APIKeyMetaData    `json:"metaData,omitempty"`
	Permissions           APIKeyPermissions `json:"permissions,omitempty"`
	TenantId              string            `json:"tenantId,omitempty"`
}

*

  • domain POJO to represent AuthenticationKey *
  • @author sanjay

type APIKeyMetaData

type APIKeyMetaData struct {
	Attributes map[string]string `json:"attributes,omitempty"`
}

type APIKeyPermissions

type APIKeyPermissions struct {
	Endpoints map[string][]string `json:"endpoints,omitempty"`
}

type APIKeyRequest

type APIKeyRequest struct {
	ApiKey      APIKey `json:"apiKey,omitempty"`
	SourceKeyId string `json:"sourceKeyId,omitempty"`
}

*

  • Authentication key request object. *
  • @author Sanjay

type APIKeyResponse

type APIKeyResponse struct {
	BaseHTTPResponse
	ApiKey APIKey `json:"apiKey,omitempty"`
}

*

  • Authentication key response object. *
  • @author Sanjay

func (*APIKeyResponse) SetStatus

func (b *APIKeyResponse) SetStatus(status int)

type AccessToken

type AccessToken struct {
	BaseHTTPResponse
	AccessToken    string    `json:"access_token,omitempty"`
	ExpiresIn      int       `json:"expires_in,omitempty"`
	IdToken        string    `json:"id_token,omitempty"`
	RefreshToken   string    `json:"refresh_token,omitempty"`
	RefreshTokenId string    `json:"refresh_token_id,omitempty"`
	Scope          string    `json:"scope,omitempty"`
	TokenType      TokenType `json:"token_type,omitempty"`
	UserId         string    `json:"userId,omitempty"`
}

*

  • @author Daniel DeGroff

func (*AccessToken) SetStatus

func (b *AccessToken) SetStatus(status int)

type ActionData

type ActionData struct {
	ActioneeUserId string   `json:"actioneeUserId,omitempty"`
	ActionerUserId string   `json:"actionerUserId,omitempty"`
	ApplicationIds []string `json:"applicationIds,omitempty"`
	Comment        string   `json:"comment,omitempty"`
	EmailUser      bool     `json:"emailUser"`
	Expiry         int64    `json:"expiry,omitempty"`
	NotifyUser     bool     `json:"notifyUser"`
	Option         string   `json:"option,omitempty"`
	ReasonId       string   `json:"reasonId,omitempty"`
	UserActionId   string   `json:"userActionId,omitempty"`
}

type ActionRequest

type ActionRequest struct {
	BaseEventRequest
	Action    ActionData `json:"action,omitempty"`
	Broadcast bool       `json:"broadcast"`
}

*

  • The user action request object. *
  • @author Brian Pontarelli

type ActionResponse

type ActionResponse struct {
	BaseHTTPResponse
	Action  UserActionLog   `json:"action,omitempty"`
	Actions []UserActionLog `json:"actions,omitempty"`
}

*

  • The user action response object. *
  • @author Brian Pontarelli

func (*ActionResponse) SetStatus

func (b *ActionResponse) SetStatus(status int)

type Algorithm

type Algorithm string

*

  • Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation. *
  • @author Daniel DeGroff
const (
	Algorithm_ES256 Algorithm = "ES256"
	Algorithm_ES384 Algorithm = "ES384"
	Algorithm_ES512 Algorithm = "ES512"
	Algorithm_HS256 Algorithm = "HS256"
	Algorithm_HS384 Algorithm = "HS384"
	Algorithm_HS512 Algorithm = "HS512"
	Algorithm_PS256 Algorithm = "PS256"
	Algorithm_PS384 Algorithm = "PS384"
	Algorithm_PS512 Algorithm = "PS512"
	Algorithm_RS256 Algorithm = "RS256"
	Algorithm_RS384 Algorithm = "RS384"
	Algorithm_RS512 Algorithm = "RS512"
	Algorithm_None  Algorithm = "none"
)

func (Algorithm) String

func (e Algorithm) String() string

type AppleApplicationConfiguration

type AppleApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	BundleId   string `json:"bundleId,omitempty"`
	ButtonText string `json:"buttonText,omitempty"`
	KeyId      string `json:"keyId,omitempty"`
	Scope      string `json:"scope,omitempty"`
	ServicesId string `json:"servicesId,omitempty"`
	TeamId     string `json:"teamId,omitempty"`
}

*

  • @author Daniel DeGroff

type AppleIdentityProvider

type AppleIdentityProvider struct {
	BaseIdentityProvider
	BundleId   string `json:"bundleId,omitempty"`
	ButtonText string `json:"buttonText,omitempty"`
	KeyId      string `json:"keyId,omitempty"`
	Scope      string `json:"scope,omitempty"`
	ServicesId string `json:"servicesId,omitempty"`
	TeamId     string `json:"teamId,omitempty"`
}

*

  • @author Daniel DeGroff

type Application

type Application struct {
	AccessControlConfiguration       ApplicationAccessControlConfiguration      `json:"accessControlConfiguration,omitempty"`
	Active                           bool                                       `json:"active"`
	AuthenticationTokenConfiguration AuthenticationTokenConfiguration           `json:"authenticationTokenConfiguration,omitempty"`
	CleanSpeakConfiguration          CleanSpeakConfiguration                    `json:"cleanSpeakConfiguration,omitempty"`
	Data                             map[string]interface{}                     `json:"data,omitempty"`
	EmailConfiguration               ApplicationEmailConfiguration              `json:"emailConfiguration,omitempty"`
	ExternalIdentifierConfiguration  ApplicationExternalIdentifierConfiguration `json:"externalIdentifierConfiguration,omitempty"`
	FormConfiguration                ApplicationFormConfiguration               `json:"formConfiguration,omitempty"`
	Id                               string                                     `json:"id,omitempty"`
	InsertInstant                    int64                                      `json:"insertInstant,omitempty"`
	JwtConfiguration                 JWTConfiguration                           `json:"jwtConfiguration,omitempty"`
	LambdaConfiguration              LambdaConfiguration                        `json:"lambdaConfiguration,omitempty"`
	LastUpdateInstant                int64                                      `json:"lastUpdateInstant,omitempty"`
	LoginConfiguration               LoginConfiguration                         `json:"loginConfiguration,omitempty"`
	MultiFactorConfiguration         ApplicationMultiFactorConfiguration        `json:"multiFactorConfiguration,omitempty"`
	Name                             string                                     `json:"name,omitempty"`
	OauthConfiguration               OAuth2Configuration                        `json:"oauthConfiguration,omitempty"`
	PasswordlessConfiguration        PasswordlessConfiguration                  `json:"passwordlessConfiguration,omitempty"`
	RegistrationConfiguration        RegistrationConfiguration                  `json:"registrationConfiguration,omitempty"`
	RegistrationDeletePolicy         ApplicationRegistrationDeletePolicy        `json:"registrationDeletePolicy,omitempty"`
	Roles                            []ApplicationRole                          `json:"roles,omitempty"`
	Samlv2Configuration              SAMLv2Configuration                        `json:"samlv2Configuration,omitempty"`
	Scopes                           []ApplicationOAuthScope                    `json:"scopes,omitempty"`
	State                            ObjectState                                `json:"state,omitempty"`
	TenantId                         string                                     `json:"tenantId,omitempty"`
	ThemeId                          string                                     `json:"themeId,omitempty"`
	Unverified                       RegistrationUnverifiedOptions              `json:"unverified,omitempty"`
	VerificationEmailTemplateId      string                                     `json:"verificationEmailTemplateId,omitempty"`
	VerificationStrategy             VerificationStrategy                       `json:"verificationStrategy,omitempty"`
	VerifyRegistration               bool                                       `json:"verifyRegistration"`
	WebAuthnConfiguration            ApplicationWebAuthnConfiguration           `json:"webAuthnConfiguration,omitempty"`
}

*

  • @author Seth Musselman

type ApplicationAccessControlConfiguration

type ApplicationAccessControlConfiguration struct {
	UiIPAccessControlListId string `json:"uiIPAccessControlListId,omitempty"`
}

*

  • @author Daniel DeGroff

type ApplicationEmailConfiguration

type ApplicationEmailConfiguration struct {
	EmailUpdateEmailTemplateId           string `json:"emailUpdateEmailTemplateId,omitempty"`
	EmailVerificationEmailTemplateId     string `json:"emailVerificationEmailTemplateId,omitempty"`
	EmailVerifiedEmailTemplateId         string `json:"emailVerifiedEmailTemplateId,omitempty"`
	ForgotPasswordEmailTemplateId        string `json:"forgotPasswordEmailTemplateId,omitempty"`
	LoginIdInUseOnCreateEmailTemplateId  string `json:"loginIdInUseOnCreateEmailTemplateId,omitempty"`
	LoginIdInUseOnUpdateEmailTemplateId  string `json:"loginIdInUseOnUpdateEmailTemplateId,omitempty"`
	LoginNewDeviceEmailTemplateId        string `json:"loginNewDeviceEmailTemplateId,omitempty"`
	LoginSuspiciousEmailTemplateId       string `json:"loginSuspiciousEmailTemplateId,omitempty"`
	PasswordlessEmailTemplateId          string `json:"passwordlessEmailTemplateId,omitempty"`
	PasswordResetSuccessEmailTemplateId  string `json:"passwordResetSuccessEmailTemplateId,omitempty"`
	PasswordUpdateEmailTemplateId        string `json:"passwordUpdateEmailTemplateId,omitempty"`
	SetPasswordEmailTemplateId           string `json:"setPasswordEmailTemplateId,omitempty"`
	TwoFactorMethodAddEmailTemplateId    string `json:"twoFactorMethodAddEmailTemplateId,omitempty"`
	TwoFactorMethodRemoveEmailTemplateId string `json:"twoFactorMethodRemoveEmailTemplateId,omitempty"`
}

type ApplicationExternalIdentifierConfiguration

type ApplicationExternalIdentifierConfiguration struct {
	TwoFactorTrustIdTimeToLiveInSeconds int `json:"twoFactorTrustIdTimeToLiveInSeconds,omitempty"`
}

*

  • @author Daniel DeGroff

type ApplicationFormConfiguration

type ApplicationFormConfiguration struct {
	AdminRegistrationFormId      string                       `json:"adminRegistrationFormId,omitempty"`
	SelfServiceFormConfiguration SelfServiceFormConfiguration `json:"selfServiceFormConfiguration,omitempty"`
	SelfServiceFormId            string                       `json:"selfServiceFormId,omitempty"`
}

*

  • @author Daniel DeGroff

type ApplicationMultiFactorConfiguration

type ApplicationMultiFactorConfiguration struct {
	Email       MultiFactorEmailTemplate          `json:"email,omitempty"`
	LoginPolicy MultiFactorLoginPolicy            `json:"loginPolicy,omitempty"`
	Sms         MultiFactorSMSTemplate            `json:"sms,omitempty"`
	TrustPolicy ApplicationMultiFactorTrustPolicy `json:"trustPolicy,omitempty"`
}

*

  • @author Daniel DeGroff

type ApplicationMultiFactorTrustPolicy

type ApplicationMultiFactorTrustPolicy string

*

  • @author Daniel DeGroff
const (
	ApplicationMultiFactorTrustPolicy_Any  ApplicationMultiFactorTrustPolicy = "Any"
	ApplicationMultiFactorTrustPolicy_This ApplicationMultiFactorTrustPolicy = "This"
	ApplicationMultiFactorTrustPolicy_None ApplicationMultiFactorTrustPolicy = "None"
)

func (ApplicationMultiFactorTrustPolicy) String

type ApplicationOAuthScope

type ApplicationOAuthScope struct {
	ApplicationId         string                 `json:"applicationId,omitempty"`
	Data                  map[string]interface{} `json:"data,omitempty"`
	DefaultConsentDetail  string                 `json:"defaultConsentDetail,omitempty"`
	DefaultConsentMessage string                 `json:"defaultConsentMessage,omitempty"`
	Description           string                 `json:"description,omitempty"`
	Id                    string                 `json:"id,omitempty"`
	InsertInstant         int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant     int64                  `json:"lastUpdateInstant,omitempty"`
	Name                  string                 `json:"name,omitempty"`
	Required              bool                   `json:"required"`
}

*

  • A custom OAuth scope for a specific application. *
  • @author Spencer Witt

type ApplicationOAuthScopeRequest

type ApplicationOAuthScopeRequest struct {
	Scope ApplicationOAuthScope `json:"scope,omitempty"`
}

*

  • The Application Scope API request object. *
  • @author Spencer Witt

type ApplicationOAuthScopeResponse

type ApplicationOAuthScopeResponse struct {
	BaseHTTPResponse
	Scope ApplicationOAuthScope `json:"scope,omitempty"`
}

*

  • The Application Scope API response. *
  • @author Spencer Witt

func (*ApplicationOAuthScopeResponse) SetStatus

func (b *ApplicationOAuthScopeResponse) SetStatus(status int)

type ApplicationRegistrationDeletePolicy

type ApplicationRegistrationDeletePolicy struct {
	Unverified TimeBasedDeletePolicy `json:"unverified,omitempty"`
}

*

  • A Application-level policy for deleting Users. *
  • @author Trevor Smith

type ApplicationRequest

type ApplicationRequest struct {
	BaseEventRequest
	Application         Application     `json:"application,omitempty"`
	Role                ApplicationRole `json:"role,omitempty"`
	SourceApplicationId string          `json:"sourceApplicationId,omitempty"`
}

*

  • The Application API request object. *
  • @author Brian Pontarelli

type ApplicationResponse

type ApplicationResponse struct {
	BaseHTTPResponse
	Application  Application     `json:"application,omitempty"`
	Applications []Application   `json:"applications,omitempty"`
	Role         ApplicationRole `json:"role,omitempty"`
}

*

  • The Application API response. *
  • @author Brian Pontarelli

func (*ApplicationResponse) SetStatus

func (b *ApplicationResponse) SetStatus(status int)

type ApplicationRole

type ApplicationRole struct {
	Description       string `json:"description,omitempty"`
	Id                string `json:"id,omitempty"`
	InsertInstant     int64  `json:"insertInstant,omitempty"`
	IsDefault         bool   `json:"isDefault"`
	IsSuperRole       bool   `json:"isSuperRole"`
	LastUpdateInstant int64  `json:"lastUpdateInstant,omitempty"`
	Name              string `json:"name,omitempty"`
}

*

  • A role given to a user for a specific application. *
  • @author Seth Musselman

type ApplicationSearchCriteria

type ApplicationSearchCriteria struct {
	BaseSearchCriteria
	Name     string      `json:"name,omitempty"`
	State    ObjectState `json:"state,omitempty"`
	TenantId string      `json:"tenantId,omitempty"`
}

*

  • Search criteria for Applications *
  • @author Spencer Witt

type ApplicationSearchRequest

type ApplicationSearchRequest struct {
	ExpandableRequest
	Search ApplicationSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Applications *
  • @author Spencer Witt

type ApplicationSearchResponse

type ApplicationSearchResponse struct {
	BaseHTTPResponse
	ExpandableResponse
	Applications []Application `json:"applications,omitempty"`
	Total        int64         `json:"total,omitempty"`
}

*

  • Application search response *
  • @author Spencer Witt

func (*ApplicationSearchResponse) SetStatus

func (b *ApplicationSearchResponse) SetStatus(status int)

type ApplicationWebAuthnConfiguration

type ApplicationWebAuthnConfiguration struct {
	Enableable
	BootstrapWorkflow        ApplicationWebAuthnWorkflowConfiguration `json:"bootstrapWorkflow,omitempty"`
	ReauthenticationWorkflow ApplicationWebAuthnWorkflowConfiguration `json:"reauthenticationWorkflow,omitempty"`
}

*

  • Application-level configuration for WebAuthn *
  • @author Daniel DeGroff

type ApplicationWebAuthnWorkflowConfiguration

type ApplicationWebAuthnWorkflowConfiguration struct {
	Enableable
}

*

  • @author Daniel DeGroff

type Attachment

type Attachment struct {
	Attachment []byte `json:"attachment,omitempty"`
	Mime       string `json:"mime,omitempty"`
	Name       string `json:"name,omitempty"`
}

*

  • This class is a simple attachment with a byte array, name and MIME type. *
  • @author Brian Pontarelli

type AttestationConveyancePreference

type AttestationConveyancePreference string

*

  • Used to communicate whether and how authenticator attestation should be delivered to the Relying Party *
  • @author Spencer Witt
const (
	AttestationConveyancePreference_None       AttestationConveyancePreference = "none"
	AttestationConveyancePreference_Indirect   AttestationConveyancePreference = "indirect"
	AttestationConveyancePreference_Direct     AttestationConveyancePreference = "direct"
	AttestationConveyancePreference_Enterprise AttestationConveyancePreference = "enterprise"
)

func (AttestationConveyancePreference) String

type AttestationType

type AttestationType string

*

  • 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
const (
	AttestationType_Basic           AttestationType = "basic"
	AttestationType_Self            AttestationType = "self"
	AttestationType_AttestationCa   AttestationType = "attestationCa"
	AttestationType_AnonymizationCa AttestationType = "anonymizationCa"
	AttestationType_None            AttestationType = "none"
)

func (AttestationType) String

func (e AttestationType) String() string

type AuditLog

type AuditLog struct {
	Data          map[string]interface{} `json:"data,omitempty"`
	Id            int64                  `json:"id,omitempty"`
	InsertInstant int64                  `json:"insertInstant,omitempty"`
	InsertUser    string                 `json:"insertUser,omitempty"`
	Message       string                 `json:"message,omitempty"`
	NewValue      interface{}            `json:"newValue,omitempty"`
	OldValue      interface{}            `json:"oldValue,omitempty"`
	Reason        string                 `json:"reason,omitempty"`
}

*

  • An audit log. *
  • @author Brian Pontarelli

type AuditLogConfiguration

type AuditLogConfiguration struct {
	Delete DeleteConfiguration `json:"delete,omitempty"`
}

type AuditLogCreateEvent

type AuditLogCreateEvent struct {
	BaseEvent
	AuditLog AuditLog `json:"auditLog,omitempty"`
}

*

  • Event event to an audit log was created. *
  • @author Daniel DeGroff

type AuditLogExportRequest

type AuditLogExportRequest struct {
	BaseExportRequest
	Criteria AuditLogSearchCriteria `json:"criteria,omitempty"`
}

*

  • @author Daniel DeGroff

type AuditLogRequest

type AuditLogRequest struct {
	BaseEventRequest
	AuditLog AuditLog `json:"auditLog,omitempty"`
}

*

  • @author Brian Pontarelli

type AuditLogResponse

type AuditLogResponse struct {
	BaseHTTPResponse
	AuditLog AuditLog `json:"auditLog,omitempty"`
}

*

  • Audit log response. *
  • @author Brian Pontarelli

func (*AuditLogResponse) SetStatus

func (b *AuditLogResponse) SetStatus(status int)

type AuditLogSearchCriteria

type AuditLogSearchCriteria struct {
	BaseSearchCriteria
	End      int64  `json:"end,omitempty"`
	Message  string `json:"message,omitempty"`
	NewValue string `json:"newValue,omitempty"`
	OldValue string `json:"oldValue,omitempty"`
	Reason   string `json:"reason,omitempty"`
	Start    int64  `json:"start,omitempty"`
	User     string `json:"user,omitempty"`
}

*

  • @author Brian Pontarelli

type AuditLogSearchRequest

type AuditLogSearchRequest struct {
	Search AuditLogSearchCriteria `json:"search,omitempty"`
}

*

  • @author Brian Pontarelli

type AuditLogSearchResponse

type AuditLogSearchResponse struct {
	BaseHTTPResponse
	AuditLogs []AuditLog `json:"auditLogs,omitempty"`
	Total     int64      `json:"total,omitempty"`
}

*

  • Audit log response. *
  • @author Brian Pontarelli

func (*AuditLogSearchResponse) SetStatus

func (b *AuditLogSearchResponse) SetStatus(status int)

type AuthenticationThreats

type AuthenticationThreats string

*

  • @author Brett Pontarelli
const (
	AuthenticationThreats_ImpossibleTravel AuthenticationThreats = "ImpossibleTravel"
)

func (AuthenticationThreats) String

func (e AuthenticationThreats) String() string

type AuthenticationTokenConfiguration

type AuthenticationTokenConfiguration struct {
	Enableable
}

type AuthenticatorAttachment

type AuthenticatorAttachment string

*

const (
	AuthenticatorAttachment_Platform      AuthenticatorAttachment = "platform"
	AuthenticatorAttachment_CrossPlatform AuthenticatorAttachment = "crossPlatform"
)

func (AuthenticatorAttachment) String

func (e AuthenticatorAttachment) String() string

type AuthenticatorAttachmentPreference

type AuthenticatorAttachmentPreference string

*

  • Describes the authenticator attachment modality preference for a WebAuthn workflow. See {@link AuthenticatorAttachment} *
  • @author Spencer Witt
const (
	AuthenticatorAttachmentPreference_Any           AuthenticatorAttachmentPreference = "any"
	AuthenticatorAttachmentPreference_Platform      AuthenticatorAttachmentPreference = "platform"
	AuthenticatorAttachmentPreference_CrossPlatform AuthenticatorAttachmentPreference = "crossPlatform"
)

func (AuthenticatorAttachmentPreference) String

type AuthenticatorConfiguration

type AuthenticatorConfiguration struct {
	Algorithm  TOTPAlgorithm `json:"algorithm,omitempty"`
	CodeLength int           `json:"codeLength,omitempty"`
	TimeStep   int           `json:"timeStep,omitempty"`
}

*

  • @author Daniel DeGroff

type AuthenticatorSelectionCriteria

type AuthenticatorSelectionCriteria struct {
	AuthenticatorAttachment AuthenticatorAttachment     `json:"authenticatorAttachment,omitempty"`
	RequireResidentKey      bool                        `json:"requireResidentKey"`
	ResidentKey             ResidentKeyRequirement      `json:"residentKey,omitempty"`
	UserVerification        UserVerificationRequirement `json:"userVerification,omitempty"`
}

*

  • 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. *
  • @author Spencer Witt

type BaseConnectorConfiguration

type BaseConnectorConfiguration struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Debug             bool                   `json:"debug"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Type              ConnectorType          `json:"type,omitempty"`
}

Do not require a setter for 'type', it is defined by the concrete class and is not mutable

type BaseElasticSearchCriteria

type BaseElasticSearchCriteria struct {
	BaseSearchCriteria
	AccurateTotal bool        `json:"accurateTotal"`
	Ids           []string    `json:"ids,omitempty"`
	NextResults   string      `json:"nextResults,omitempty"`
	Query         string      `json:"query,omitempty"`
	QueryString   string      `json:"queryString,omitempty"`
	SortFields    []SortField `json:"sortFields,omitempty"`
}

*

  • @author Brian Pontarelli

type BaseEvent

type BaseEvent struct {
	CreateInstant int64     `json:"createInstant,omitempty"`
	Id            string    `json:"id,omitempty"`
	Info          EventInfo `json:"info,omitempty"`
	TenantId      string    `json:"tenantId,omitempty"`
	Type          EventType `json:"type,omitempty"`
}

*

  • Base-class for all FusionAuth events. *
  • @author Brian Pontarelli

type BaseEventRequest

type BaseEventRequest struct {
	EventInfo EventInfo `json:"eventInfo,omitempty"`
}

*

  • 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. *
  • @author Brian Pontarelli

type BaseExportRequest

type BaseExportRequest struct {
	DateTimeSecondsFormat string `json:"dateTimeSecondsFormat,omitempty"`
	ZoneId                string `json:"zoneId,omitempty"`
}

*

  • @author Daniel DeGroff

type BaseHTTPResponse

type BaseHTTPResponse struct {
	StatusCode int `json:"statusCode,omitempty"`
}

* * Base Response which contains the HTTP status code * * @author Matthew Altman

func (*BaseHTTPResponse) SetStatus

func (b *BaseHTTPResponse) SetStatus(status int)

type BaseIdentityProvider

type BaseIdentityProvider struct {
	Enableable
	ApplicationConfiguration map[string]interface{}                         `json:"applicationConfiguration,omitempty"`
	Data                     map[string]interface{}                         `json:"data,omitempty"`
	Debug                    bool                                           `json:"debug"`
	Id                       string                                         `json:"id,omitempty"`
	InsertInstant            int64                                          `json:"insertInstant,omitempty"`
	LambdaConfiguration      ProviderLambdaConfiguration                    `json:"lambdaConfiguration,omitempty"`
	LastUpdateInstant        int64                                          `json:"lastUpdateInstant,omitempty"`
	LinkingStrategy          IdentityProviderLinkingStrategy                `json:"linkingStrategy,omitempty"`
	Name                     string                                         `json:"name,omitempty"`
	TenantConfiguration      map[string]IdentityProviderTenantConfiguration `json:"tenantConfiguration,omitempty"`
	Type                     IdentityProviderType                           `json:"type,omitempty"`
}

Do not require a setter for 'type', it is defined by the concrete class and is not mutable

type BaseIdentityProviderApplicationConfiguration

type BaseIdentityProviderApplicationConfiguration struct {
	Enableable
	CreateRegistration bool                   `json:"createRegistration"`
	Data               map[string]interface{} `json:"data,omitempty"`
}

*

  • @author Daniel DeGroff

type BaseLoginRequest

type BaseLoginRequest struct {
	BaseEventRequest
	ApplicationId string   `json:"applicationId,omitempty"`
	IpAddress     string   `json:"ipAddress,omitempty"`
	MetaData      MetaData `json:"metaData,omitempty"`
	NewDevice     bool     `json:"newDevice"`
	NoJWT         bool     `json:"noJWT"`
}

*

  • @author Daniel DeGroff

type BaseMessengerConfiguration

type BaseMessengerConfiguration struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Debug             bool                   `json:"debug"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Transport         string                 `json:"transport,omitempty"`
	Type              MessengerType          `json:"type,omitempty"`
}

Do not require a setter for 'type', it is defined by the concrete class and is not mutable

type BaseSAMLv2IdentityProvider

type BaseSAMLv2IdentityProvider struct {
	BaseIdentityProvider
	EmailClaim        string `json:"emailClaim,omitempty"`
	KeyId             string `json:"keyId,omitempty"`
	UniqueIdClaim     string `json:"uniqueIdClaim,omitempty"`
	UseNameIdForEmail bool   `json:"useNameIdForEmail"`
	UsernameClaim     string `json:"usernameClaim,omitempty"`
}

*

  • @author Lyle Schemmerling

type BaseSearchCriteria

type BaseSearchCriteria struct {
	NumberOfResults int    `json:"numberOfResults,omitempty"`
	OrderBy         string `json:"orderBy,omitempty"`
	StartRow        int    `json:"startRow,omitempty"`
}

*

  • @author Brian Pontarelli

type BreachAction

type BreachAction string
const (
	BreachAction_Off           BreachAction = "Off"
	BreachAction_RecordOnly    BreachAction = "RecordOnly"
	BreachAction_NotifyUser    BreachAction = "NotifyUser"
	BreachAction_RequireChange BreachAction = "RequireChange"
)

func (BreachAction) String

func (e BreachAction) String() string

type BreachMatchMode

type BreachMatchMode string
const (
	BreachMatchMode_Low    BreachMatchMode = "Low"
	BreachMatchMode_Medium BreachMatchMode = "Medium"
	BreachMatchMode_High   BreachMatchMode = "High"
)

func (BreachMatchMode) String

func (e BreachMatchMode) String() string

type BreachedPasswordStatus

type BreachedPasswordStatus string

*

  • @author Daniel DeGroff
const (
	BreachedPasswordStatus_None            BreachedPasswordStatus = "None"
	BreachedPasswordStatus_ExactMatch      BreachedPasswordStatus = "ExactMatch"
	BreachedPasswordStatus_SubAddressMatch BreachedPasswordStatus = "SubAddressMatch"
	BreachedPasswordStatus_PasswordOnly    BreachedPasswordStatus = "PasswordOnly"
	BreachedPasswordStatus_CommonPassword  BreachedPasswordStatus = "CommonPassword"
)

func (BreachedPasswordStatus) String

func (e BreachedPasswordStatus) String() string

type BreachedPasswordTenantMetric

type BreachedPasswordTenantMetric struct {
	ActionRequired             int `json:"actionRequired,omitempty"`
	MatchedCommonPasswordCount int `json:"matchedCommonPasswordCount,omitempty"`
	MatchedExactCount          int `json:"matchedExactCount,omitempty"`
	MatchedPasswordCount       int `json:"matchedPasswordCount,omitempty"`
	MatchedSubAddressCount     int `json:"matchedSubAddressCount,omitempty"`
	PasswordsCheckedCount      int `json:"passwordsCheckedCount,omitempty"`
}

*

  • @author Daniel DeGroff

type CORSConfiguration

type CORSConfiguration struct {
	Enableable
	AllowCredentials         bool         `json:"allowCredentials"`
	AllowedHeaders           []string     `json:"allowedHeaders,omitempty"`
	AllowedMethods           []HTTPMethod `json:"allowedMethods,omitempty"`
	AllowedOrigins           []string     `json:"allowedOrigins,omitempty"`
	Debug                    bool         `json:"debug"`
	ExposedHeaders           []string     `json:"exposedHeaders,omitempty"`
	PreflightMaxAgeInSeconds int          `json:"preflightMaxAgeInSeconds,omitempty"`
}

*

  • @author Trevor Smith

type CanonicalizationMethod

type CanonicalizationMethod string

*

  • XML canonicalization method enumeration. This is used for the IdP and SP side of FusionAuth SAML. *
  • @author Brian Pontarelli
const (
	CanonicalizationMethod_Exclusive             CanonicalizationMethod = "exclusive"
	CanonicalizationMethod_ExclusiveWithComments CanonicalizationMethod = "exclusive_with_comments"
	CanonicalizationMethod_Inclusive             CanonicalizationMethod = "inclusive"
	CanonicalizationMethod_InclusiveWithComments CanonicalizationMethod = "inclusive_with_comments"
)

func (CanonicalizationMethod) String

func (e CanonicalizationMethod) String() string

type CaptchaMethod

type CaptchaMethod string

*

  • @author Brett Pontarelli
const (
	CaptchaMethod_GoogleRecaptchaV2  CaptchaMethod = "GoogleRecaptchaV2"
	CaptchaMethod_GoogleRecaptchaV3  CaptchaMethod = "GoogleRecaptchaV3"
	CaptchaMethod_HCaptcha           CaptchaMethod = "HCaptcha"
	CaptchaMethod_HCaptchaEnterprise CaptchaMethod = "HCaptchaEnterprise"
)

func (CaptchaMethod) String

func (e CaptchaMethod) String() string

type CertificateInformation

type CertificateInformation struct {
	Issuer            string `json:"issuer,omitempty"`
	Md5Fingerprint    string `json:"md5Fingerprint,omitempty"`
	SerialNumber      string `json:"serialNumber,omitempty"`
	Sha1Fingerprint   string `json:"sha1Fingerprint,omitempty"`
	Sha1Thumbprint    string `json:"sha1Thumbprint,omitempty"`
	Sha256Fingerprint string `json:"sha256Fingerprint,omitempty"`
	Sha256Thumbprint  string `json:"sha256Thumbprint,omitempty"`
	Subject           string `json:"subject,omitempty"`
	ValidFrom         int64  `json:"validFrom,omitempty"`
	ValidTo           int64  `json:"validTo,omitempty"`
}

type ChangePasswordReason

type ChangePasswordReason string

*

  • @author Trevor Smith
const (
	ChangePasswordReason_Administrative ChangePasswordReason = "Administrative"
	ChangePasswordReason_Breached       ChangePasswordReason = "Breached"
	ChangePasswordReason_Expired        ChangePasswordReason = "Expired"
	ChangePasswordReason_Validation     ChangePasswordReason = "Validation"
)

func (ChangePasswordReason) String

func (e ChangePasswordReason) String() string

type ChangePasswordRequest

type ChangePasswordRequest struct {
	BaseEventRequest
	ApplicationId    string `json:"applicationId,omitempty"`
	ChangePasswordId string `json:"changePasswordId,omitempty"`
	CurrentPassword  string `json:"currentPassword,omitempty"`
	LoginId          string `json:"loginId,omitempty"`
	Password         string `json:"password,omitempty"`
	RefreshToken     string `json:"refreshToken,omitempty"`
	TrustChallenge   string `json:"trustChallenge,omitempty"`
	TrustToken       string `json:"trustToken,omitempty"`
}

*

  • Change password request object. *
  • @author Brian Pontarelli

type ChangePasswordResponse

type ChangePasswordResponse struct {
	BaseHTTPResponse
	OneTimePassword string                 `json:"oneTimePassword,omitempty"`
	State           map[string]interface{} `json:"state,omitempty"`
}

*

  • Change password response object. *
  • @author Daniel DeGroff

func (*ChangePasswordResponse) SetStatus

func (b *ChangePasswordResponse) SetStatus(status int)

type CleanSpeakConfiguration

type CleanSpeakConfiguration struct {
	Enableable
	ApiKey             string             `json:"apiKey,omitempty"`
	ApplicationIds     []string           `json:"applicationIds,omitempty"`
	Url                string             `json:"url,omitempty"`
	UsernameModeration UsernameModeration `json:"usernameModeration,omitempty"`
}

*

  • CleanSpeak configuration at the system and application level. *
  • @author Brian Pontarelli

type ClientAuthenticationMethod

type ClientAuthenticationMethod string
const (
	ClientAuthenticationMethod_None              ClientAuthenticationMethod = "none"
	ClientAuthenticationMethod_ClientSecretBasic ClientAuthenticationMethod = "client_secret_basic"
	ClientAuthenticationMethod_ClientSecretPost  ClientAuthenticationMethod = "client_secret_post"
)

func (ClientAuthenticationMethod) String

type ClientAuthenticationPolicy

type ClientAuthenticationPolicy string

*

  • @author Brett Guy
const (
	ClientAuthenticationPolicy_Required                 ClientAuthenticationPolicy = "Required"
	ClientAuthenticationPolicy_NotRequired              ClientAuthenticationPolicy = "NotRequired"
	ClientAuthenticationPolicy_NotRequiredWhenUsingPKCE ClientAuthenticationPolicy = "NotRequiredWhenUsingPKCE"
)

func (ClientAuthenticationPolicy) String

type ConnectorLambdaConfiguration

type ConnectorLambdaConfiguration struct {
	ReconcileId string `json:"reconcileId,omitempty"`
}

type ConnectorPolicy

type ConnectorPolicy struct {
	ConnectorId string                 `json:"connectorId,omitempty"`
	Data        map[string]interface{} `json:"data,omitempty"`
	Domains     []string               `json:"domains,omitempty"`
	Migrate     bool                   `json:"migrate"`
}

*

  • @author Trevor Smith

type ConnectorRequest

type ConnectorRequest struct {
	Connector BaseConnectorConfiguration `json:"connector,omitempty"`
}

*

  • @author Trevor Smith

type ConnectorResponse

type ConnectorResponse struct {
	BaseHTTPResponse
	Connector  BaseConnectorConfiguration   `json:"connector,omitempty"`
	Connectors []BaseConnectorConfiguration `json:"connectors,omitempty"`
}

*

  • @author Trevor Smith

func (*ConnectorResponse) SetStatus

func (b *ConnectorResponse) SetStatus(status int)

type ConnectorType

type ConnectorType string

*

  • The types of connectors. This enum is stored as an ordinal on the <code>identities</code> table, order must be maintained. *
  • @author Trevor Smith
const (
	ConnectorType_FusionAuth ConnectorType = "FusionAuth"
	ConnectorType_Generic    ConnectorType = "Generic"
	ConnectorType_LDAP       ConnectorType = "LDAP"
)

func (ConnectorType) String

func (e ConnectorType) String() string
type Consent struct {
	ConsentEmailTemplateId          string                 `json:"consentEmailTemplateId,omitempty"`
	CountryMinimumAgeForSelfConsent map[string]int         `json:"countryMinimumAgeForSelfConsent,omitempty"`
	Data                            map[string]interface{} `json:"data,omitempty"`
	DefaultMinimumAgeForSelfConsent int                    `json:"defaultMinimumAgeForSelfConsent,omitempty"`
	EmailPlus                       EmailPlus              `json:"emailPlus,omitempty"`
	Id                              string                 `json:"id,omitempty"`
	InsertInstant                   int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant               int64                  `json:"lastUpdateInstant,omitempty"`
	MultipleValuesAllowed           bool                   `json:"multipleValuesAllowed"`
	Name                            string                 `json:"name,omitempty"`
	Values                          []string               `json:"values,omitempty"`
}

*

  • Models a consent. *
  • @author Daniel DeGroff

type ConsentRequest

type ConsentRequest struct {
	Consent Consent `json:"consent,omitempty"`
}

*

  • API request for User consent types. *
  • @author Daniel DeGroff

type ConsentResponse

type ConsentResponse struct {
	BaseHTTPResponse
	Consent  Consent   `json:"consent,omitempty"`
	Consents []Consent `json:"consents,omitempty"`
}

*

  • API response for consent. *
  • @author Daniel DeGroff

func (*ConsentResponse) SetStatus

func (b *ConsentResponse) SetStatus(status int)

type ConsentSearchCriteria

type ConsentSearchCriteria struct {
	BaseSearchCriteria
	Name string `json:"name,omitempty"`
}

*

  • Search criteria for Consents *
  • @author Spencer Witt

type ConsentSearchRequest

type ConsentSearchRequest struct {
	Search ConsentSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Consents *
  • @author Spencer Witt

type ConsentSearchResponse

type ConsentSearchResponse struct {
	BaseHTTPResponse
	Consents []Consent `json:"consents,omitempty"`
	Total    int64     `json:"total,omitempty"`
}

*

  • Consent search response *
  • @author Spencer Witt

func (*ConsentSearchResponse) SetStatus

func (b *ConsentSearchResponse) SetStatus(status int)

type ConsentStatus

type ConsentStatus string

*

  • Models a consent. *
  • @author Daniel DeGroff
const (
	ConsentStatus_Active  ConsentStatus = "Active"
	ConsentStatus_Revoked ConsentStatus = "Revoked"
)

func (ConsentStatus) String

func (e ConsentStatus) String() string

type ContentStatus

type ContentStatus string

*

  • Status for content like usernames, profile attributes, etc. *
  • @author Brian Pontarelli
const (
	ContentStatus_ACTIVE   ContentStatus = "ACTIVE"
	ContentStatus_PENDING  ContentStatus = "PENDING"
	ContentStatus_REJECTED ContentStatus = "REJECTED"
)

func (ContentStatus) String

func (e ContentStatus) String() string

type CoseAlgorithmIdentifier

type CoseAlgorithmIdentifier string

*

const (
	CoseAlgorithmIdentifier_ES256 CoseAlgorithmIdentifier = "ES256"
	CoseAlgorithmIdentifier_ES384 CoseAlgorithmIdentifier = "ES384"
	CoseAlgorithmIdentifier_ES512 CoseAlgorithmIdentifier = "ES512"
	CoseAlgorithmIdentifier_RS256 CoseAlgorithmIdentifier = "RS256"
	CoseAlgorithmIdentifier_RS384 CoseAlgorithmIdentifier = "RS384"
	CoseAlgorithmIdentifier_RS512 CoseAlgorithmIdentifier = "RS512"
	CoseAlgorithmIdentifier_PS256 CoseAlgorithmIdentifier = "PS256"
	CoseAlgorithmIdentifier_PS384 CoseAlgorithmIdentifier = "PS384"
	CoseAlgorithmIdentifier_PS512 CoseAlgorithmIdentifier = "PS512"
)

func (CoseAlgorithmIdentifier) String

func (e CoseAlgorithmIdentifier) String() string

type CoseEllipticCurve

type CoseEllipticCurve string

*

  • COSE Elliptic Curve identifier to determine which elliptic curve to use with a given key *
  • @author Spencer Witt
const (
	CoseEllipticCurve_Reserved  CoseEllipticCurve = "Reserved"
	CoseEllipticCurve_P256      CoseEllipticCurve = "P256"
	CoseEllipticCurve_P384      CoseEllipticCurve = "P384"
	CoseEllipticCurve_P521      CoseEllipticCurve = "P521"
	CoseEllipticCurve_X25519    CoseEllipticCurve = "X25519"
	CoseEllipticCurve_X448      CoseEllipticCurve = "X448"
	CoseEllipticCurve_Ed25519   CoseEllipticCurve = "Ed25519"
	CoseEllipticCurve_Ed448     CoseEllipticCurve = "Ed448"
	CoseEllipticCurve_Secp256k1 CoseEllipticCurve = "Secp256k1"
)

func (CoseEllipticCurve) String

func (e CoseEllipticCurve) String() string

type CoseKeyType

type CoseKeyType string

*

  • COSE key type *
  • @author Spencer Witt
const (
	CoseKeyType_Reserved  CoseKeyType = "Reserved"
	CoseKeyType_OKP       CoseKeyType = "OKP"
	CoseKeyType_EC2       CoseKeyType = "EC2"
	CoseKeyType_RSA       CoseKeyType = "RSA"
	CoseKeyType_Symmetric CoseKeyType = "Symmetric"
)

func (CoseKeyType) String

func (e CoseKeyType) String() string

type Count

type Count struct {
	Count    int `json:"count,omitempty"`
	Interval int `json:"interval,omitempty"`
}

*

  • @author Brian Pontarelli

type CredentialPropertiesOutput

type CredentialPropertiesOutput struct {
	Rk bool `json:"rk"`
}

*

  • Contains the output for the {@code credProps} extension *
  • @author Spencer Witt

type DailyActiveUserReportResponse

type DailyActiveUserReportResponse struct {
	BaseHTTPResponse
	DailyActiveUsers []Count `json:"dailyActiveUsers,omitempty"`
	Total            int64   `json:"total,omitempty"`
}

*

  • Response for the daily active user report. *
  • @author Brian Pontarelli

func (*DailyActiveUserReportResponse) SetStatus

func (b *DailyActiveUserReportResponse) SetStatus(status int)

type DeleteConfiguration

type DeleteConfiguration struct {
	Enableable
	NumberOfDaysToRetain int `json:"numberOfDaysToRetain,omitempty"`
}

type DeviceApprovalResponse

type DeviceApprovalResponse struct {
	BaseHTTPResponse
	DeviceGrantStatus    string               `json:"deviceGrantStatus,omitempty"`
	DeviceInfo           DeviceInfo           `json:"deviceInfo,omitempty"`
	IdentityProviderLink IdentityProviderLink `json:"identityProviderLink,omitempty"`
	TenantId             string               `json:"tenantId,omitempty"`
	UserId               string               `json:"userId,omitempty"`
}

*

  • @author Daniel DeGroff

func (*DeviceApprovalResponse) SetStatus

func (b *DeviceApprovalResponse) SetStatus(status int)

type DeviceInfo

type DeviceInfo struct {
	Description         string `json:"description,omitempty"`
	LastAccessedAddress string `json:"lastAccessedAddress,omitempty"`
	LastAccessedInstant int64  `json:"lastAccessedInstant,omitempty"`
	Name                string `json:"name,omitempty"`
	Type                string `json:"type,omitempty"`
}

*

  • @author Daniel DeGroff

type DeviceResponse

type DeviceResponse struct {
	BaseHTTPResponse
	DeviceCode              string `json:"device_code,omitempty"`
	ExpiresIn               int    `json:"expires_in,omitempty"`
	Interval                int    `json:"interval,omitempty"`
	UserCode                string `json:"user_code,omitempty"`
	VerificationUri         string `json:"verification_uri,omitempty"`
	VerificationUriComplete string `json:"verification_uri_complete,omitempty"`
}

*

  • @author Trevor Smith

func (*DeviceResponse) SetStatus

func (b *DeviceResponse) SetStatus(status int)

type DeviceType

type DeviceType string
const (
	DeviceType_BROWSER DeviceType = "BROWSER"
	DeviceType_DESKTOP DeviceType = "DESKTOP"
	DeviceType_LAPTOP  DeviceType = "LAPTOP"
	DeviceType_MOBILE  DeviceType = "MOBILE"
	DeviceType_OTHER   DeviceType = "OTHER"
	DeviceType_SERVER  DeviceType = "SERVER"
	DeviceType_TABLET  DeviceType = "TABLET"
	DeviceType_TV      DeviceType = "TV"
	DeviceType_UNKNOWN DeviceType = "UNKNOWN"
)

func (DeviceType) String

func (e DeviceType) String() string

type DeviceUserCodeResponse

type DeviceUserCodeResponse struct {
	BaseHTTPResponse
	ClientId       string         `json:"client_id,omitempty"`
	DeviceInfo     DeviceInfo     `json:"deviceInfo,omitempty"`
	ExpiresIn      int            `json:"expires_in,omitempty"`
	PendingIdPLink PendingIdPLink `json:"pendingIdPLink,omitempty"`
	Scope          string         `json:"scope,omitempty"`
	TenantId       string         `json:"tenantId,omitempty"`
	UserCode       string         `json:"user_code,omitempty"`
}

*

  • @author Daniel DeGroff

func (*DeviceUserCodeResponse) SetStatus

func (b *DeviceUserCodeResponse) SetStatus(status int)

type DisplayableRawLogin

type DisplayableRawLogin struct {
	RawLogin
	ApplicationName string   `json:"applicationName,omitempty"`
	Location        Location `json:"location,omitempty"`
	LoginId         string   `json:"loginId,omitempty"`
}

*

  • A displayable raw login that includes application name and user loginId. *
  • @author Brian Pontarelli

type DomainBasedIdentityProvider

type DomainBasedIdentityProvider struct {
}

*

  • Interface for all identity providers that can be domain based.

type Email

type Email struct {
	Attachments []Attachment   `json:"attachments,omitempty"`
	Bcc         []EmailAddress `json:"bcc,omitempty"`
	Cc          []EmailAddress `json:"cc,omitempty"`
	From        EmailAddress   `json:"from,omitempty"`
	Html        string         `json:"html,omitempty"`
	ReplyTo     EmailAddress   `json:"replyTo,omitempty"`
	Subject     string         `json:"subject,omitempty"`
	Text        string         `json:"text,omitempty"`
	To          []EmailAddress `json:"to,omitempty"`
}

*

  • This class is an abstraction of a simple email message. *
  • @author Brian Pontarelli

type EmailAddress

type EmailAddress struct {
	Address string `json:"address,omitempty"`
	Display string `json:"display,omitempty"`
}

*

  • An email address. *
  • @author Brian Pontarelli

type EmailConfiguration

type EmailConfiguration struct {
	AdditionalHeaders                    []EmailHeader          `json:"additionalHeaders,omitempty"`
	Debug                                bool                   `json:"debug"`
	DefaultFromEmail                     string                 `json:"defaultFromEmail,omitempty"`
	DefaultFromName                      string                 `json:"defaultFromName,omitempty"`
	EmailUpdateEmailTemplateId           string                 `json:"emailUpdateEmailTemplateId,omitempty"`
	EmailVerifiedEmailTemplateId         string                 `json:"emailVerifiedEmailTemplateId,omitempty"`
	ForgotPasswordEmailTemplateId        string                 `json:"forgotPasswordEmailTemplateId,omitempty"`
	Host                                 string                 `json:"host,omitempty"`
	ImplicitEmailVerificationAllowed     bool                   `json:"implicitEmailVerificationAllowed"`
	LoginIdInUseOnCreateEmailTemplateId  string                 `json:"loginIdInUseOnCreateEmailTemplateId,omitempty"`
	LoginIdInUseOnUpdateEmailTemplateId  string                 `json:"loginIdInUseOnUpdateEmailTemplateId,omitempty"`
	LoginNewDeviceEmailTemplateId        string                 `json:"loginNewDeviceEmailTemplateId,omitempty"`
	LoginSuspiciousEmailTemplateId       string                 `json:"loginSuspiciousEmailTemplateId,omitempty"`
	Password                             string                 `json:"password,omitempty"`
	PasswordlessEmailTemplateId          string                 `json:"passwordlessEmailTemplateId,omitempty"`
	PasswordResetSuccessEmailTemplateId  string                 `json:"passwordResetSuccessEmailTemplateId,omitempty"`
	PasswordUpdateEmailTemplateId        string                 `json:"passwordUpdateEmailTemplateId,omitempty"`
	Port                                 int                    `json:"port,omitempty"`
	Properties                           string                 `json:"properties,omitempty"`
	Security                             EmailSecurityType      `json:"security,omitempty"`
	SetPasswordEmailTemplateId           string                 `json:"setPasswordEmailTemplateId,omitempty"`
	TwoFactorMethodAddEmailTemplateId    string                 `json:"twoFactorMethodAddEmailTemplateId,omitempty"`
	TwoFactorMethodRemoveEmailTemplateId string                 `json:"twoFactorMethodRemoveEmailTemplateId,omitempty"`
	Unverified                           EmailUnverifiedOptions `json:"unverified,omitempty"`
	Username                             string                 `json:"username,omitempty"`
	VerificationEmailTemplateId          string                 `json:"verificationEmailTemplateId,omitempty"`
	VerificationStrategy                 VerificationStrategy   `json:"verificationStrategy,omitempty"`
	VerifyEmail                          bool                   `json:"verifyEmail"`
	VerifyEmailWhenChanged               bool                   `json:"verifyEmailWhenChanged"`
}

*

  • @author Brian Pontarelli

type EmailHeader

type EmailHeader struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

*

  • @author Daniel DeGroff

type EmailPlus

type EmailPlus struct {
	Enableable
	EmailTemplateId               string `json:"emailTemplateId,omitempty"`
	MaximumTimeToSendEmailInHours int    `json:"maximumTimeToSendEmailInHours,omitempty"`
	MinimumTimeToSendEmailInHours int    `json:"minimumTimeToSendEmailInHours,omitempty"`
}

type EmailSecurityType

type EmailSecurityType string
const (
	EmailSecurityType_NONE EmailSecurityType = "NONE"
	EmailSecurityType_SSL  EmailSecurityType = "SSL"
	EmailSecurityType_TLS  EmailSecurityType = "TLS"
)

func (EmailSecurityType) String

func (e EmailSecurityType) String() string

type EmailTemplate

type EmailTemplate struct {
	DefaultFromName        string            `json:"defaultFromName,omitempty"`
	DefaultHtmlTemplate    string            `json:"defaultHtmlTemplate,omitempty"`
	DefaultSubject         string            `json:"defaultSubject,omitempty"`
	DefaultTextTemplate    string            `json:"defaultTextTemplate,omitempty"`
	FromEmail              string            `json:"fromEmail,omitempty"`
	Id                     string            `json:"id,omitempty"`
	InsertInstant          int64             `json:"insertInstant,omitempty"`
	LastUpdateInstant      int64             `json:"lastUpdateInstant,omitempty"`
	LocalizedFromNames     map[string]string `json:"localizedFromNames,omitempty"`
	LocalizedHtmlTemplates map[string]string `json:"localizedHtmlTemplates,omitempty"`
	LocalizedSubjects      map[string]string `json:"localizedSubjects,omitempty"`
	LocalizedTextTemplates map[string]string `json:"localizedTextTemplates,omitempty"`
	Name                   string            `json:"name,omitempty"`
}

*

  • Stores an email template used to send emails to users. *
  • @author Brian Pontarelli

type EmailTemplateErrors

type EmailTemplateErrors struct {
	ParseErrors  map[string]string `json:"parseErrors,omitempty"`
	RenderErrors map[string]string `json:"renderErrors,omitempty"`
}

type EmailTemplateRequest

type EmailTemplateRequest struct {
	EmailTemplate EmailTemplate `json:"emailTemplate,omitempty"`
}

*

  • Email template request. *
  • @author Brian Pontarelli

type EmailTemplateResponse

type EmailTemplateResponse struct {
	BaseHTTPResponse
	EmailTemplate  EmailTemplate   `json:"emailTemplate,omitempty"`
	EmailTemplates []EmailTemplate `json:"emailTemplates,omitempty"`
}

*

  • Email template response. *
  • @author Brian Pontarelli

func (*EmailTemplateResponse) SetStatus

func (b *EmailTemplateResponse) SetStatus(status int)

type EmailTemplateSearchCriteria

type EmailTemplateSearchCriteria struct {
	BaseSearchCriteria
	Name string `json:"name,omitempty"`
}

*

  • Search criteria for Email templates *
  • @author Mark Manes

type EmailTemplateSearchRequest

type EmailTemplateSearchRequest struct {
	Search EmailTemplateSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for email templates *
  • @author Mark Manes

type EmailTemplateSearchResponse

type EmailTemplateSearchResponse struct {
	BaseHTTPResponse
	EmailTemplates []EmailTemplate `json:"emailTemplates,omitempty"`
	Total          int64           `json:"total,omitempty"`
}

*

  • Email template search response *
  • @author Mark Manes

func (*EmailTemplateSearchResponse) SetStatus

func (b *EmailTemplateSearchResponse) SetStatus(status int)

type EmailUnverifiedOptions

type EmailUnverifiedOptions struct {
	AllowEmailChangeWhenGated bool               `json:"allowEmailChangeWhenGated"`
	Behavior                  UnverifiedBehavior `json:"behavior,omitempty"`
}

*

  • @author Daniel DeGroff

type Enableable

type Enableable struct {
	Enabled bool `json:"enabled"`
}

*

  • Something that can be enabled and thus also disabled. *
  • @author Daniel DeGroff

type Entity

type Entity struct {
	ClientId          string                 `json:"clientId,omitempty"`
	ClientSecret      string                 `json:"clientSecret,omitempty"`
	Data              map[string]interface{} `json:"data,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
	ParentId          string                 `json:"parentId,omitempty"`
	TenantId          string                 `json:"tenantId,omitempty"`
	Type              EntityType             `json:"type,omitempty"`
}

*

  • Models an entity that a user can be granted permissions to. Or an entity that can be granted permissions to another entity. *
  • @author Brian Pontarelli

type EntityGrant

type EntityGrant struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Entity            Entity                 `json:"entity,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Permissions       []string               `json:"permissions,omitempty"`
	RecipientEntityId string                 `json:"recipientEntityId,omitempty"`
	UserId            string                 `json:"userId,omitempty"`
}

*

  • A grant for an entity to a user or another entity. *
  • @author Brian Pontarelli

type EntityGrantRequest

type EntityGrantRequest struct {
	Grant EntityGrant `json:"grant,omitempty"`
}

*

  • Entity grant API request object. *
  • @author Brian Pontarelli

type EntityGrantResponse

type EntityGrantResponse struct {
	BaseHTTPResponse
	Grant  EntityGrant   `json:"grant,omitempty"`
	Grants []EntityGrant `json:"grants,omitempty"`
}

*

  • Entity grant API response object. *
  • @author Brian Pontarelli

func (*EntityGrantResponse) SetStatus

func (b *EntityGrantResponse) SetStatus(status int)

type EntityGrantSearchCriteria

type EntityGrantSearchCriteria struct {
	BaseSearchCriteria
	EntityId string `json:"entityId,omitempty"`
	Name     string `json:"name,omitempty"`
	UserId   string `json:"userId,omitempty"`
}

*

  • Search criteria for entity grants. *
  • @author Brian Pontarelli

type EntityGrantSearchRequest

type EntityGrantSearchRequest struct {
	Search EntityGrantSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for entity grants. *
  • @author Brian Pontarelli

type EntityGrantSearchResponse

type EntityGrantSearchResponse struct {
	BaseHTTPResponse
	Grants []EntityGrant `json:"grants,omitempty"`
	Total  int64         `json:"total,omitempty"`
}

*

  • Search request for entity grants. *
  • @author Brian Pontarelli

func (*EntityGrantSearchResponse) SetStatus

func (b *EntityGrantSearchResponse) SetStatus(status int)

type EntityJWTConfiguration

type EntityJWTConfiguration struct {
	Enableable
	AccessTokenKeyId    string `json:"accessTokenKeyId,omitempty"`
	TimeToLiveInSeconds int    `json:"timeToLiveInSeconds,omitempty"`
}

*

  • JWT Configuration for entities.

type EntityRequest

type EntityRequest struct {
	Entity Entity `json:"entity,omitempty"`
}

*

  • Entity API request object. *
  • @author Brian Pontarelli

type EntityResponse

type EntityResponse struct {
	BaseHTTPResponse
	Entity Entity `json:"entity,omitempty"`
}

*

  • Entity API response object. *
  • @author Brian Pontarelli

func (*EntityResponse) SetStatus

func (b *EntityResponse) SetStatus(status int)

type EntitySearchCriteria

type EntitySearchCriteria struct {
	BaseElasticSearchCriteria
}

*

  • This class is the entity query. It provides a build pattern as well as public fields for use on forms and in actions. *
  • @author Brian Pontarelli

type EntitySearchRequest

type EntitySearchRequest struct {
	Search EntitySearchCriteria `json:"search,omitempty"`
}

*

  • Search request for entities *
  • @author Brett Guy

type EntitySearchResponse

type EntitySearchResponse struct {
	BaseHTTPResponse
	Entities    []Entity `json:"entities,omitempty"`
	NextResults string   `json:"nextResults,omitempty"`
	Total       int64    `json:"total,omitempty"`
}

*

  • Search request for entities *
  • @author Brett Guy

func (*EntitySearchResponse) SetStatus

func (b *EntitySearchResponse) SetStatus(status int)

type EntityType

type EntityType struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	JwtConfiguration  EntityJWTConfiguration `json:"jwtConfiguration,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Permissions       []EntityTypePermission `json:"permissions,omitempty"`
}

*

  • Models an entity type that has a specific set of permissions. These are global objects and can be used across tenants. *
  • @author Brian Pontarelli

type EntityTypePermission

type EntityTypePermission struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Description       string                 `json:"description,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	IsDefault         bool                   `json:"isDefault"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
}

*

  • Models a specific entity type permission. This permission can be granted to users or other entities. *
  • @author Brian Pontarelli

type EntityTypeRequest

type EntityTypeRequest struct {
	EntityType EntityType           `json:"entityType,omitempty"`
	Permission EntityTypePermission `json:"permission,omitempty"`
}

*

  • Entity Type API request object. *
  • @author Brian Pontarelli

type EntityTypeResponse

type EntityTypeResponse struct {
	BaseHTTPResponse
	EntityType  EntityType           `json:"entityType,omitempty"`
	EntityTypes []EntityType         `json:"entityTypes,omitempty"`
	Permission  EntityTypePermission `json:"permission,omitempty"`
}

*

  • Entity Type API response object. *
  • @author Brian Pontarelli

func (*EntityTypeResponse) SetStatus

func (b *EntityTypeResponse) SetStatus(status int)

type EntityTypeSearchCriteria

type EntityTypeSearchCriteria struct {
	BaseSearchCriteria
	Name string `json:"name,omitempty"`
}

*

  • Search criteria for entity types. *
  • @author Brian Pontarelli

type EntityTypeSearchRequest

type EntityTypeSearchRequest struct {
	Search EntityTypeSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for entity types. *
  • @author Brian Pontarelli

type EntityTypeSearchResponse

type EntityTypeSearchResponse struct {
	BaseHTTPResponse
	EntityTypes []EntityType `json:"entityTypes,omitempty"`
	Total       int64        `json:"total,omitempty"`
}

*

  • Search response for entity types. *
  • @author Brian Pontarelli

func (*EntityTypeSearchResponse) SetStatus

func (b *EntityTypeSearchResponse) SetStatus(status int)

type EpicGamesApplicationConfiguration

type EpicGamesApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ButtonText   string `json:"buttonText,omitempty"`
	ClientId     string `json:"client_id,omitempty"`
	ClientSecret string `json:"client_secret,omitempty"`
	Scope        string `json:"scope,omitempty"`
}

*

  • @author Brett Pontarelli

type EpicGamesIdentityProvider

type EpicGamesIdentityProvider struct {
	BaseIdentityProvider
	ButtonText   string `json:"buttonText,omitempty"`
	ClientId     string `json:"client_id,omitempty"`
	ClientSecret string `json:"client_secret,omitempty"`
	Scope        string `json:"scope,omitempty"`
}

*

  • Epic gaming login provider. *
  • @author Brett Pontarelli

type Error

type Error struct {
	Code    string                 `json:"code,omitempty"`
	Data    map[string]interface{} `json:"data,omitempty"`
	Message string                 `json:"message,omitempty"`
}

*

  • Defines an error. *
  • @author Brian Pontarelli

type Errors

type Errors struct {
	FieldErrors   map[string][]Error `json:"fieldErrors,omitempty"`
	GeneralErrors []Error            `json:"generalErrors,omitempty"`
}

*

  • Standard error domain object that can also be used as the response from an API call. *
  • @author Brian Pontarelli

func (Errors) Error

func (e Errors) Error() string

func (Errors) Present

func (e Errors) Present() bool

type EventConfiguration

type EventConfiguration struct {
	Events map[EventType]EventConfigurationData `json:"events,omitempty"`
}

*

  • @author Brian Pontarelli

type EventConfigurationData

type EventConfigurationData struct {
	Enableable
	TransactionType TransactionType `json:"transactionType,omitempty"`
}

type EventInfo

type EventInfo struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	DeviceDescription string                 `json:"deviceDescription,omitempty"`
	DeviceName        string                 `json:"deviceName,omitempty"`
	DeviceType        string                 `json:"deviceType,omitempty"`
	IpAddress         string                 `json:"ipAddress,omitempty"`
	Location          Location               `json:"location,omitempty"`
	Os                string                 `json:"os,omitempty"`
	UserAgent         string                 `json:"userAgent,omitempty"`
}

*

  • Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc). *
  • @author Brian Pontarelli

type EventLog

type EventLog struct {
	Id            int64        `json:"id,omitempty"`
	InsertInstant int64        `json:"insertInstant,omitempty"`
	Message       string       `json:"message,omitempty"`
	Type          EventLogType `json:"type,omitempty"`
}

*

  • Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc. *
  • @author Brian Pontarelli

type EventLogConfiguration

type EventLogConfiguration struct {
	NumberToRetain int `json:"numberToRetain,omitempty"`
}

type EventLogCreateEvent

type EventLogCreateEvent struct {
	BaseEvent
	EventLog EventLog `json:"eventLog,omitempty"`
}

*

  • An Event "event" to indicate an event log was created. *
  • @author Daniel DeGroff

type EventLogResponse

type EventLogResponse struct {
	BaseHTTPResponse
	EventLog EventLog `json:"eventLog,omitempty"`
}

*

  • Event log response. *
  • @author Daniel DeGroff

func (*EventLogResponse) SetStatus

func (b *EventLogResponse) SetStatus(status int)

type EventLogSearchCriteria

type EventLogSearchCriteria struct {
	BaseSearchCriteria
	End     int64        `json:"end,omitempty"`
	Message string       `json:"message,omitempty"`
	Start   int64        `json:"start,omitempty"`
	Type    EventLogType `json:"type,omitempty"`
}

*

  • Search criteria for the event log. *
  • @author Brian Pontarelli

type EventLogSearchRequest

type EventLogSearchRequest struct {
	Search EventLogSearchCriteria `json:"search,omitempty"`
}

*

  • @author Brian Pontarelli

type EventLogSearchResponse

type EventLogSearchResponse struct {
	BaseHTTPResponse
	EventLogs []EventLog `json:"eventLogs,omitempty"`
	Total     int64      `json:"total,omitempty"`
}

*

  • Event log response. *
  • @author Brian Pontarelli

func (*EventLogSearchResponse) SetStatus

func (b *EventLogSearchResponse) SetStatus(status int)

type EventLogType

type EventLogType string

*

  • Event Log Type *
  • @author Daniel DeGroff
const (
	EventLogType_Information EventLogType = "Information"
	EventLogType_Debug       EventLogType = "Debug"
	EventLogType_Error       EventLogType = "Error"
)

func (EventLogType) String

func (e EventLogType) String() string

type EventRequest

type EventRequest struct {
	Event BaseEvent `json:"event,omitempty"`
}

*

  • Container for the event information. This is the JSON that is sent from FusionAuth to webhooks. *
  • @author Brian Pontarelli

type EventType

type EventType string

*

  • Models the event types that FusionAuth produces. *
  • @author Brian Pontarelli
const (
	EventType_JWTPublicKeyUpdate             EventType = "jwt.public-key.update"
	EventType_JWTRefreshTokenRevoke          EventType = "jwt.refresh-token.revoke"
	EventType_JWTRefresh                     EventType = "jwt.refresh"
	EventType_AuditLogCreate                 EventType = "audit-log.create"
	EventType_EventLogCreate                 EventType = "event-log.create"
	EventType_KickstartSuccess               EventType = "kickstart.success"
	EventType_GroupCreate                    EventType = "group.create"
	EventType_GroupCreateComplete            EventType = "group.create.complete"
	EventType_GroupDelete                    EventType = "group.delete"
	EventType_GroupDeleteComplete            EventType = "group.delete.complete"
	EventType_GroupMemberAdd                 EventType = "group.member.add"
	EventType_GroupMemberAddComplete         EventType = "group.member.add.complete"
	EventType_GroupMemberRemove              EventType = "group.member.remove"
	EventType_GroupMemberRemoveComplete      EventType = "group.member.remove.complete"
	EventType_GroupMemberUpdate              EventType = "group.member.update"
	EventType_GroupMemberUpdateComplete      EventType = "group.member.update.complete"
	EventType_GroupUpdate                    EventType = "group.update"
	EventType_GroupUpdateComplete            EventType = "group.update.complete"
	EventType_UserAction                     EventType = "user.action"
	EventType_UserBulkCreate                 EventType = "user.bulk.create"
	EventType_UserCreate                     EventType = "user.create"
	EventType_UserCreateComplete             EventType = "user.create.complete"
	EventType_UserDeactivate                 EventType = "user.deactivate"
	EventType_UserDelete                     EventType = "user.delete"
	EventType_UserDeleteComplete             EventType = "user.delete.complete"
	EventType_UserEmailUpdate                EventType = "user.email.update"
	EventType_UserEmailVerified              EventType = "user.email.verified"
	EventType_UserIdentityProviderLink       EventType = "user.identity-provider.link"
	EventType_UserIdentityProviderUnlink     EventType = "user.identity-provider.unlink"
	EventType_UserLoginIdDuplicateOnCreate   EventType = "user.loginId.duplicate.create"
	EventType_UserLoginIdDuplicateOnUpdate   EventType = "user.loginId.duplicate.update"
	EventType_UserLoginFailed                EventType = "user.login.failed"
	EventType_UserLoginNewDevice             EventType = "user.login.new-device"
	EventType_UserLoginSuccess               EventType = "user.login.success"
	EventType_UserLoginSuspicious            EventType = "user.login.suspicious"
	EventType_UserPasswordBreach             EventType = "user.password.breach"
	EventType_UserPasswordResetSend          EventType = "user.password.reset.send"
	EventType_UserPasswordResetStart         EventType = "user.password.reset.start"
	EventType_UserPasswordResetSuccess       EventType = "user.password.reset.success"
	EventType_UserPasswordUpdate             EventType = "user.password.update"
	EventType_UserReactivate                 EventType = "user.reactivate"
	EventType_UserRegistrationCreate         EventType = "user.registration.create"
	EventType_UserRegistrationCreateComplete EventType = "user.registration.create.complete"
	EventType_UserRegistrationDelete         EventType = "user.registration.delete"
	EventType_UserRegistrationDeleteComplete EventType = "user.registration.delete.complete"
	EventType_UserRegistrationUpdate         EventType = "user.registration.update"
	EventType_UserRegistrationUpdateComplete EventType = "user.registration.update.complete"
	EventType_UserRegistrationVerified       EventType = "user.registration.verified"
	EventType_UserTwoFactorMethodAdd         EventType = "user.two-factor.method.add"
	EventType_UserTwoFactorMethodRemove      EventType = "user.two-factor.method.remove"
	EventType_UserUpdate                     EventType = "user.update"
	EventType_UserUpdateComplete             EventType = "user.update.complete"
	EventType_Test                           EventType = "test"
)

func (EventType) String

func (e EventType) String() string

type ExpandableRequest

type ExpandableRequest struct {
	Expand []string `json:"expand,omitempty"`
}

*

  • An expandable API request. *
  • @author Daniel DeGroff

type ExpandableResponse

type ExpandableResponse struct {
	BaseHTTPResponse
	Expandable []string `json:"expandable,omitempty"`
}

*

  • An expandable API response. *
  • @author Daniel DeGroff

func (*ExpandableResponse) SetStatus

func (b *ExpandableResponse) SetStatus(status int)

type ExpiryUnit

type ExpiryUnit string

*

  • @author Brian Pontarelli
const (
	ExpiryUnit_MINUTES ExpiryUnit = "MINUTES"
	ExpiryUnit_HOURS   ExpiryUnit = "HOURS"
	ExpiryUnit_DAYS    ExpiryUnit = "DAYS"
	ExpiryUnit_WEEKS   ExpiryUnit = "WEEKS"
	ExpiryUnit_MONTHS  ExpiryUnit = "MONTHS"
	ExpiryUnit_YEARS   ExpiryUnit = "YEARS"
)

func (ExpiryUnit) String

func (e ExpiryUnit) String() string

type ExternalIdentifierConfiguration

type ExternalIdentifierConfiguration struct {
	AuthorizationGrantIdTimeToLiveInSeconds            int                          `json:"authorizationGrantIdTimeToLiveInSeconds,omitempty"`
	ChangePasswordIdGenerator                          SecureGeneratorConfiguration `json:"changePasswordIdGenerator,omitempty"`
	ChangePasswordIdTimeToLiveInSeconds                int                          `json:"changePasswordIdTimeToLiveInSeconds,omitempty"`
	DeviceCodeTimeToLiveInSeconds                      int                          `json:"deviceCodeTimeToLiveInSeconds,omitempty"`
	DeviceUserCodeIdGenerator                          SecureGeneratorConfiguration `json:"deviceUserCodeIdGenerator,omitempty"`
	EmailVerificationIdGenerator                       SecureGeneratorConfiguration `json:"emailVerificationIdGenerator,omitempty"`
	EmailVerificationIdTimeToLiveInSeconds             int                          `json:"emailVerificationIdTimeToLiveInSeconds,omitempty"`
	EmailVerificationOneTimeCodeGenerator              SecureGeneratorConfiguration `json:"emailVerificationOneTimeCodeGenerator,omitempty"`
	ExternalAuthenticationIdTimeToLiveInSeconds        int                          `json:"externalAuthenticationIdTimeToLiveInSeconds,omitempty"`
	OneTimePasswordTimeToLiveInSeconds                 int                          `json:"oneTimePasswordTimeToLiveInSeconds,omitempty"`
	PasswordlessLoginGenerator                         SecureGeneratorConfiguration `json:"passwordlessLoginGenerator,omitempty"`
	PasswordlessLoginTimeToLiveInSeconds               int                          `json:"passwordlessLoginTimeToLiveInSeconds,omitempty"`
	PendingAccountLinkTimeToLiveInSeconds              int                          `json:"pendingAccountLinkTimeToLiveInSeconds,omitempty"`
	RegistrationVerificationIdGenerator                SecureGeneratorConfiguration `json:"registrationVerificationIdGenerator,omitempty"`
	RegistrationVerificationIdTimeToLiveInSeconds      int                          `json:"registrationVerificationIdTimeToLiveInSeconds,omitempty"`
	RegistrationVerificationOneTimeCodeGenerator       SecureGeneratorConfiguration `json:"registrationVerificationOneTimeCodeGenerator,omitempty"`
	RememberOAuthScopeConsentChoiceTimeToLiveInSeconds int                          `json:"rememberOAuthScopeConsentChoiceTimeToLiveInSeconds,omitempty"`
	Samlv2AuthNRequestIdTimeToLiveInSeconds            int                          `json:"samlv2AuthNRequestIdTimeToLiveInSeconds,omitempty"`
	SetupPasswordIdGenerator                           SecureGeneratorConfiguration `json:"setupPasswordIdGenerator,omitempty"`
	SetupPasswordIdTimeToLiveInSeconds                 int                          `json:"setupPasswordIdTimeToLiveInSeconds,omitempty"`
	TrustTokenTimeToLiveInSeconds                      int                          `json:"trustTokenTimeToLiveInSeconds,omitempty"`
	TwoFactorIdTimeToLiveInSeconds                     int                          `json:"twoFactorIdTimeToLiveInSeconds,omitempty"`
	TwoFactorOneTimeCodeIdGenerator                    SecureGeneratorConfiguration `json:"twoFactorOneTimeCodeIdGenerator,omitempty"`
	TwoFactorOneTimeCodeIdTimeToLiveInSeconds          int                          `json:"twoFactorOneTimeCodeIdTimeToLiveInSeconds,omitempty"`
	TwoFactorTrustIdTimeToLiveInSeconds                int                          `json:"twoFactorTrustIdTimeToLiveInSeconds,omitempty"`
	WebAuthnAuthenticationChallengeTimeToLiveInSeconds int                          `json:"webAuthnAuthenticationChallengeTimeToLiveInSeconds,omitempty"`
	WebAuthnRegistrationChallengeTimeToLiveInSeconds   int                          `json:"webAuthnRegistrationChallengeTimeToLiveInSeconds,omitempty"`
}

*

  • @author Daniel DeGroff

type ExternalJWTApplicationConfiguration

type ExternalJWTApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
}

*

  • @author Daniel DeGroff

type ExternalJWTIdentityProvider

type ExternalJWTIdentityProvider struct {
	BaseIdentityProvider
	ClaimMap            map[string]string                   `json:"claimMap,omitempty"`
	DefaultKeyId        string                              `json:"defaultKeyId,omitempty"`
	Domains             []string                            `json:"domains,omitempty"`
	HeaderKeyParameter  string                              `json:"headerKeyParameter,omitempty"`
	Oauth2              IdentityProviderOauth2Configuration `json:"oauth2,omitempty"`
	UniqueIdentityClaim string                              `json:"uniqueIdentityClaim,omitempty"`
}

*

  • External JWT-only identity provider. *
  • @author Daniel DeGroff and Brian Pontarelli

type FacebookApplicationConfiguration

type FacebookApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	AppId        string                      `json:"appId,omitempty"`
	ButtonText   string                      `json:"buttonText,omitempty"`
	ClientSecret string                      `json:"client_secret,omitempty"`
	Fields       string                      `json:"fields,omitempty"`
	LoginMethod  IdentityProviderLoginMethod `json:"loginMethod,omitempty"`
	Permissions  string                      `json:"permissions,omitempty"`
}

*

  • @author Daniel DeGroff

type FacebookIdentityProvider

type FacebookIdentityProvider struct {
	BaseIdentityProvider
	AppId        string                      `json:"appId,omitempty"`
	ButtonText   string                      `json:"buttonText,omitempty"`
	ClientSecret string                      `json:"client_secret,omitempty"`
	Fields       string                      `json:"fields,omitempty"`
	LoginMethod  IdentityProviderLoginMethod `json:"loginMethod,omitempty"`
	Permissions  string                      `json:"permissions,omitempty"`
}

*

  • Facebook social login provider. *
  • @author Brian Pontarelli

type FailedAuthenticationActionCancelPolicy

type FailedAuthenticationActionCancelPolicy struct {
	OnPasswordReset bool `json:"onPasswordReset"`
}

*

  • A policy to configure if and when the user-action is canceled prior to the expiration of the action. *
  • @author Daniel DeGroff

type FailedAuthenticationConfiguration

type FailedAuthenticationConfiguration struct {
	ActionCancelPolicy  FailedAuthenticationActionCancelPolicy `json:"actionCancelPolicy,omitempty"`
	ActionDuration      int64                                  `json:"actionDuration,omitempty"`
	ActionDurationUnit  ExpiryUnit                             `json:"actionDurationUnit,omitempty"`
	EmailUser           bool                                   `json:"emailUser"`
	ResetCountInSeconds int                                    `json:"resetCountInSeconds,omitempty"`
	TooManyAttempts     int                                    `json:"tooManyAttempts,omitempty"`
	UserActionId        string                                 `json:"userActionId,omitempty"`
}

*

  • Configuration for the behavior of failed login attempts. This helps us protect against brute force password attacks. *
  • @author Daniel DeGroff

type Family

type Family struct {
	Id                string         `json:"id,omitempty"`
	InsertInstant     int64          `json:"insertInstant,omitempty"`
	LastUpdateInstant int64          `json:"lastUpdateInstant,omitempty"`
	Members           []FamilyMember `json:"members,omitempty"`
}

*

  • Models a family grouping of users. *
  • @author Brian Pontarelli

type FamilyConfiguration

type FamilyConfiguration struct {
	Enableable
	AllowChildRegistrations           bool   `json:"allowChildRegistrations"`
	ConfirmChildEmailTemplateId       string `json:"confirmChildEmailTemplateId,omitempty"`
	DeleteOrphanedAccounts            bool   `json:"deleteOrphanedAccounts"`
	DeleteOrphanedAccountsDays        int    `json:"deleteOrphanedAccountsDays,omitempty"`
	FamilyRequestEmailTemplateId      string `json:"familyRequestEmailTemplateId,omitempty"`
	MaximumChildAge                   int    `json:"maximumChildAge,omitempty"`
	MinimumOwnerAge                   int    `json:"minimumOwnerAge,omitempty"`
	ParentEmailRequired               bool   `json:"parentEmailRequired"`
	ParentRegistrationEmailTemplateId string `json:"parentRegistrationEmailTemplateId,omitempty"`
}

*

  • @author Brian Pontarelli

type FamilyEmailRequest

type FamilyEmailRequest struct {
	ParentEmail string `json:"parentEmail,omitempty"`
}

*

  • API request for sending out family requests to parent's. *
  • @author Brian Pontarelli

type FamilyMember

type FamilyMember struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Owner             bool                   `json:"owner"`
	Role              FamilyRole             `json:"role,omitempty"`
	UserId            string                 `json:"userId,omitempty"`
}

*

  • Models a single family member. *
  • @author Brian Pontarelli

type FamilyRequest

type FamilyRequest struct {
	FamilyMember FamilyMember `json:"familyMember,omitempty"`
}

*

  • API request for managing families and members. *
  • @author Brian Pontarelli

type FamilyResponse

type FamilyResponse struct {
	BaseHTTPResponse
	Families []Family `json:"families,omitempty"`
	Family   Family   `json:"family,omitempty"`
}

*

  • API response for managing families and members. *
  • @author Brian Pontarelli

func (*FamilyResponse) SetStatus

func (b *FamilyResponse) SetStatus(status int)

type FamilyRole

type FamilyRole string
const (
	FamilyRole_Child FamilyRole = "Child"
	FamilyRole_Teen  FamilyRole = "Teen"
	FamilyRole_Adult FamilyRole = "Adult"
)

func (FamilyRole) String

func (e FamilyRole) String() string

type ForgotPasswordRequest

type ForgotPasswordRequest struct {
	BaseEventRequest
	ApplicationId           string                 `json:"applicationId,omitempty"`
	ChangePasswordId        string                 `json:"changePasswordId,omitempty"`
	Email                   string                 `json:"email,omitempty"`
	LoginId                 string                 `json:"loginId,omitempty"`
	SendForgotPasswordEmail bool                   `json:"sendForgotPasswordEmail"`
	State                   map[string]interface{} `json:"state,omitempty"`
	Username                string                 `json:"username,omitempty"`
}

*

  • Forgot password request object. *
  • @author Brian Pontarelli

type ForgotPasswordResponse

type ForgotPasswordResponse struct {
	BaseHTTPResponse
	ChangePasswordId string `json:"changePasswordId,omitempty"`
}

*

  • Forgot password response object. *
  • @author Daniel DeGroff

func (*ForgotPasswordResponse) SetStatus

func (b *ForgotPasswordResponse) SetStatus(status int)

type Form

type Form struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Steps             []FormStep             `json:"steps,omitempty"`
	Type              FormType               `json:"type,omitempty"`
}

*

  • @author Daniel DeGroff

type FormControl

type FormControl string

*

  • @author Daniel DeGroff
const (
	FormControl_Checkbox FormControl = "checkbox"
	FormControl_Number   FormControl = "number"
	FormControl_Password FormControl = "password"
	FormControl_Radio    FormControl = "radio"
	FormControl_Select   FormControl = "select"
	FormControl_Textarea FormControl = "textarea"
	FormControl_Text     FormControl = "text"
)

func (FormControl) String

func (e FormControl) String() string

type FormDataType

type FormDataType string

*

  • @author Daniel DeGroff
const (
	FormDataType_Bool    FormDataType = "bool"
	FormDataType_Consent FormDataType = "consent"
	FormDataType_Date    FormDataType = "date"
	FormDataType_Email   FormDataType = "email"
	FormDataType_Number  FormDataType = "number"
	FormDataType_String  FormDataType = "string"
)

func (FormDataType) String

func (e FormDataType) String() string

type FormField

type FormField struct {
	Confirm           bool                   `json:"confirm"`
	ConsentId         string                 `json:"consentId,omitempty"`
	Control           FormControl            `json:"control,omitempty"`
	Data              map[string]interface{} `json:"data,omitempty"`
	Description       string                 `json:"description,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	Key               string                 `json:"key,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Options           []string               `json:"options,omitempty"`
	Required          bool                   `json:"required"`
	Type              FormDataType           `json:"type,omitempty"`
	Validator         FormFieldValidator     `json:"validator,omitempty"`
}

*

  • @author Daniel DeGroff

type FormFieldAdminPolicy

type FormFieldAdminPolicy string

*

  • @author Daniel DeGroff
const (
	FormFieldAdminPolicy_Edit FormFieldAdminPolicy = "Edit"
	FormFieldAdminPolicy_View FormFieldAdminPolicy = "View"
)

func (FormFieldAdminPolicy) String

func (e FormFieldAdminPolicy) String() string

type FormFieldRequest

type FormFieldRequest struct {
	Field  FormField   `json:"field,omitempty"`
	Fields []FormField `json:"fields,omitempty"`
}

*

  • The FormField API request object. *
  • @author Brett Guy

type FormFieldResponse

type FormFieldResponse struct {
	BaseHTTPResponse
	Field  FormField   `json:"field,omitempty"`
	Fields []FormField `json:"fields,omitempty"`
}

*

  • Form field response. *
  • @author Brett Guy

func (*FormFieldResponse) SetStatus

func (b *FormFieldResponse) SetStatus(status int)

type FormFieldValidator

type FormFieldValidator struct {
	Enableable
	Expression string `json:"expression,omitempty"`
}

*

  • @author Daniel DeGroff

type For