fusionauth

package
v0.0.0-...-3d43b82 Latest Latest
Warning

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

 Go to latest Published: Apr 7, 2025 License: Apache-2.0 Imports: 12 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey 

type APIKey struct {
	ExpirationInstant     int64             `json:"expirationInstant,omitempty"`
	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"`
	Name                  string            `json:"name,omitempty"`
	Permissions           APIKeyPermissions `json:"permissions,omitempty"`
	Retrievable           bool              `json:"retrievable"`
	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 

func (e ApplicationMultiFactorTrustPolicy) String() 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 

func (e AttestationConveyancePreference) String() 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 to indicate 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 

func (e AuthenticatorAttachmentPreference) String() 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 BaseGroupEvent 

type BaseGroupEvent struct {
	BaseEvent
	Group Group `json:"group,omitempty"`
}

*

  • Base class for all {@link Group} and {@link GroupMember} events. *
  • @author Spencer Witt

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
	AssertionDecryptionConfiguration SAMLv2AssertionDecryptionConfiguration `json:"assertionDecryptionConfiguration,omitempty"`
	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 BaseUserEvent 

type BaseUserEvent struct {
	BaseEvent
	User User `json:"user,omitempty"`
}

*

  • Base class for all {@link User}-related events. *
  • @author Spencer Witt

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 

func (e ClientAuthenticationMethod) String() 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 

func (e ClientAuthenticationPolicy) String() 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"`
	LoginIntentTimeToLiveInSeconds                     int                          `json:"loginIntentTimeToLiveInSeconds,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 FormRequest 

type FormRequest struct {
	Form Form `json:"form,omitempty"`
}

*

  • Form response. *
  • @author Daniel DeGroff

type FormResponse 

type FormResponse struct {
	BaseHTTPResponse
	Form  Form   `json:"form,omitempty"`
	Forms []Form `json:"forms,omitempty"`
}

*

  • Form response. *
  • @author Daniel DeGroff

func (*FormResponse) SetStatus 

func (b *FormResponse) SetStatus(status int)

type FormStep 

type FormStep struct {
	Fields []string `json:"fields,omitempty"`
}

*

  • @author Daniel DeGroff

type FormType 

type FormType string

*

  • @author Daniel DeGroff
const (
	FormType_Registration      FormType = "registration"
	FormType_AdminRegistration FormType = "adminRegistration"
	FormType_AdminUser         FormType = "adminUser"
	FormType_SelfServiceUser   FormType = "selfServiceUser"
)

func (FormType) String 

func (e FormType) String() string

type FusionAuthClient 

type FusionAuthClient struct {
	HTTPClient *http.Client
	BaseURL    *url.URL
	APIKey     string
	Debug      bool
	TenantId   string
}

FusionAuthClient describes the Go Client for interacting with FusionAuth's RESTful API

func NewClient 

func NewClient(httpClient *http.Client, baseURL *url.URL, apiKey string) *FusionAuthClient

NewClient creates a new FusionAuthClient if httpClient is nil then a DefaultClient is used

func (*FusionAuthClient) ActionUser 

func (c *FusionAuthClient) ActionUser(request ActionRequest) (*ActionResponse, *Errors, error)

ActionUser Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the "actioner". Both user ids are required in the request object. 

ActionRequest request The action request that includes all the information about the action being taken including
the Id of the action, any options and the duration (if applicable).

func (*FusionAuthClient) ActionUserWithContext 

func (c *FusionAuthClient) ActionUserWithContext(ctx context.Context, request ActionRequest) (*ActionResponse, *Errors, error)

ActionUserWithContext Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the "actioner". Both user ids are required in the request object. 

ActionRequest request The action request that includes all the information about the action being taken including
the Id of the action, any options and the duration (if applicable).

func (*FusionAuthClient) ActivateReactor 

func (c *FusionAuthClient) ActivateReactor(request ReactorRequest) (*BaseHTTPResponse, *Errors, error)

ActivateReactor Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments) 

ReactorRequest request An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).

func (*FusionAuthClient) ActivateReactorWithContext 

func (c *FusionAuthClient) ActivateReactorWithContext(ctx context.Context, request ReactorRequest) (*BaseHTTPResponse, *Errors, error)

ActivateReactorWithContext Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments) 

ReactorRequest request An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).

func (*FusionAuthClient) AddUserToFamily 

func (c *FusionAuthClient) AddUserToFamily(familyId string, request FamilyRequest) (*FamilyResponse, *Errors, error)

AddUserToFamily Adds a user to an existing family. The family Id must be specified. 

string familyId The Id of the family.
FamilyRequest request The request object that contains all the information used to determine which user to add to the family.

func (*FusionAuthClient) AddUserToFamilyWithContext 

func (c *FusionAuthClient) AddUserToFamilyWithContext(ctx context.Context, familyId string, request FamilyRequest) (*FamilyResponse, *Errors, error)

AddUserToFamilyWithContext Adds a user to an existing family. The family Id must be specified. 

string familyId The Id of the family.
FamilyRequest request The request object that contains all the information used to determine which user to add to the family.

func (*FusionAuthClient) ApproveDevice 

func (c *FusionAuthClient) ApproveDevice(clientId string, clientSecret string, token string, userCode string) (*DeviceApprovalResponse, *Errors, error)

ApproveDevice Approve a device grant. 

string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
string clientSecret (Optional) The client secret. This value will be required if client authentication is enabled.
string token The access token used to identify the user.
string userCode The end-user verification code.

func (*FusionAuthClient) ApproveDeviceWithContext 

func (c *FusionAuthClient) ApproveDeviceWithContext(ctx context.Context, clientId string, clientSecret string, token string, userCode string) (*DeviceApprovalResponse, *Errors, error)

ApproveDeviceWithContext Approve a device grant. 

string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
string clientSecret (Optional) The client secret. This value will be required if client authentication is enabled.
string token The access token used to identify the user.
string userCode The end-user verification code.

func (*FusionAuthClient) CancelAction 

func (c *FusionAuthClient) CancelAction(actionId string, request ActionRequest) (*ActionResponse, *Errors, error)

CancelAction Cancels the user action. 

string actionId The action Id of the action to cancel.
ActionRequest request The action request that contains the information about the cancellation.

func (*FusionAuthClient) CancelActionWithContext 

func (c *FusionAuthClient) CancelActionWithContext(ctx context.Context, actionId string, request ActionRequest) (*ActionResponse, *Errors, error)

CancelActionWithContext Cancels the user action. 

string actionId The action Id of the action to cancel.
ActionRequest request The action request that contains the information about the cancellation.

func (*FusionAuthClient) ChangePassword 

func (c *FusionAuthClient) ChangePassword(changePasswordId string, request ChangePasswordRequest) (*ChangePasswordResponse, *Errors, error)

ChangePassword Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user and they clicked on a link to reset their password.

As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set the value in the request body. 

string changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
ChangePasswordRequest request The change password request that contains all the information used to change the password.

func (*FusionAuthClient) ChangePasswordByIdentity 

func (c *FusionAuthClient) ChangePasswordByIdentity(request ChangePasswordRequest) (*BaseHTTPResponse, *Errors, error)

ChangePasswordByIdentity Changes a user's password using their identity (loginId and password). Using a loginId instead of the changePasswordId bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword method. 

ChangePasswordRequest request The change password request that contains all the information used to change the password.

func (*FusionAuthClient) ChangePasswordByIdentityWithContext 

func (c *FusionAuthClient) ChangePasswordByIdentityWithContext(ctx context.Context, request ChangePasswordRequest) (*BaseHTTPResponse, *Errors, error)

ChangePasswordByIdentityWithContext Changes a user's password using their identity (loginId and password). Using a loginId instead of the changePasswordId bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword method. 

ChangePasswordRequest request The change password request that contains all the information used to change the password.

func (*FusionAuthClient) ChangePasswordWithContext 

func (c *FusionAuthClient) ChangePasswordWithContext(ctx context.Context, changePasswordId string, request ChangePasswordRequest) (*ChangePasswordResponse, *Errors, error)

ChangePasswordWithContext Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user and they clicked on a link to reset their password.

As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set the value in the request body. 

string changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
ChangePasswordRequest request The change password request that contains all the information used to change the password.

func (*FusionAuthClient) CheckChangePasswordUsingId 

func (c *FusionAuthClient) CheckChangePasswordUsingId(changePasswordId string) (*BaseHTTPResponse, *Errors, error)

CheckChangePasswordUsingId Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. 

string changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.

func (*FusionAuthClient) CheckChangePasswordUsingIdWithContext 

func (c *FusionAuthClient) CheckChangePasswordUsingIdWithContext(ctx context.Context, changePasswordId string) (*BaseHTTPResponse, *Errors, error)

CheckChangePasswordUsingIdWithContext Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. 

string changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.

func (*FusionAuthClient) CheckChangePasswordUsingJWT 

func (c *FusionAuthClient) CheckChangePasswordUsingJWT(encodedJWT string) (*BaseHTTPResponse, *Errors, error)

CheckChangePasswordUsingJWT Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) CheckChangePasswordUsingJWTWithContext 

func (c *FusionAuthClient) CheckChangePasswordUsingJWTWithContext(ctx context.Context, encodedJWT string) (*BaseHTTPResponse, *Errors, error)

CheckChangePasswordUsingJWTWithContext Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) CheckChangePasswordUsingLoginId 

func (c *FusionAuthClient) CheckChangePasswordUsingLoginId(loginId string) (*BaseHTTPResponse, *Errors, error)

CheckChangePasswordUsingLoginId Check to see if the user must obtain a Trust Request Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. 

string loginId The loginId of the User that you intend to change the password for.

func (*FusionAuthClient) CheckChangePasswordUsingLoginIdWithContext 

func (c *FusionAuthClient) CheckChangePasswordUsingLoginIdWithContext(ctx context.Context, loginId string) (*BaseHTTPResponse, *Errors, error)

CheckChangePasswordUsingLoginIdWithContext Check to see if the user must obtain a Trust Request Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. 

string loginId The loginId of the User that you intend to change the password for.

func (*FusionAuthClient) ClientCredentialsGrant 

func (c *FusionAuthClient) ClientCredentialsGrant(clientId string, clientSecret string, scope string) (*AccessToken, *OAuthError, error)

ClientCredentialsGrant Make a Client Credentials grant request to obtain an access token. 

string clientId (Optional) The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret used to authenticate this request.
This parameter is optional when Basic Authorization is used to authenticate this request.
string scope (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:&lt;target-entity-id&gt;:&lt;roles&gt;. Roles are an optional comma separated list.

func (*FusionAuthClient) ClientCredentialsGrantWithContext 

func (c *FusionAuthClient) ClientCredentialsGrantWithContext(ctx context.Context, clientId string, clientSecret string, scope string) (*AccessToken, *OAuthError, error)

ClientCredentialsGrantWithContext Make a Client Credentials grant request to obtain an access token. 

string clientId (Optional) The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret used to authenticate this request.
This parameter is optional when Basic Authorization is used to authenticate this request.
string scope (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:&lt;target-entity-id&gt;:&lt;roles&gt;. Roles are an optional comma separated list.

func (*FusionAuthClient) CommentOnUser 

func (c *FusionAuthClient) CommentOnUser(request UserCommentRequest) (*UserCommentResponse, *Errors, error)

CommentOnUser Adds a comment to the user's account. 

UserCommentRequest request The request object that contains all the information used to create the user comment.

func (*FusionAuthClient) CommentOnUserWithContext 

func (c *FusionAuthClient) CommentOnUserWithContext(ctx context.Context, request UserCommentRequest) (*UserCommentResponse, *Errors, error)

CommentOnUserWithContext Adds a comment to the user's account. 

UserCommentRequest request The request object that contains all the information used to create the user comment.

func (*FusionAuthClient) CompleteWebAuthnAssertion 

func (c *FusionAuthClient) CompleteWebAuthnAssertion(request WebAuthnLoginRequest) (*WebAuthnAssertResponse, *Errors, error)

CompleteWebAuthnAssertion Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in 

WebAuthnLoginRequest request An object containing data necessary for completing the authentication ceremony

func (*FusionAuthClient) CompleteWebAuthnAssertionWithContext 

func (c *FusionAuthClient) CompleteWebAuthnAssertionWithContext(ctx context.Context, request WebAuthnLoginRequest) (*WebAuthnAssertResponse, *Errors, error)

CompleteWebAuthnAssertionWithContext Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in 

WebAuthnLoginRequest request An object containing data necessary for completing the authentication ceremony

func (*FusionAuthClient) CompleteWebAuthnLogin 

func (c *FusionAuthClient) CompleteWebAuthnLogin(request WebAuthnLoginRequest) (*LoginResponse, *Errors, error)

CompleteWebAuthnLogin Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in 

WebAuthnLoginRequest request An object containing data necessary for completing the authentication ceremony

func (*FusionAuthClient) CompleteWebAuthnLoginWithContext 

func (c *FusionAuthClient) CompleteWebAuthnLoginWithContext(ctx context.Context, request WebAuthnLoginRequest) (*LoginResponse, *Errors, error)

CompleteWebAuthnLoginWithContext Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in 

WebAuthnLoginRequest request An object containing data necessary for completing the authentication ceremony

func (*FusionAuthClient) CompleteWebAuthnRegistration 

func (c *FusionAuthClient) CompleteWebAuthnRegistration(request WebAuthnRegisterCompleteRequest) (*WebAuthnRegisterCompleteResponse, *Errors, error)

CompleteWebAuthnRegistration Complete a WebAuthn registration ceremony by validating the client request and saving the new credential 

WebAuthnRegisterCompleteRequest request An object containing data necessary for completing the registration ceremony

func (*FusionAuthClient) CompleteWebAuthnRegistrationWithContext 

func (c *FusionAuthClient) CompleteWebAuthnRegistrationWithContext(ctx context.Context, request WebAuthnRegisterCompleteRequest) (*WebAuthnRegisterCompleteResponse, *Errors, error)

CompleteWebAuthnRegistrationWithContext Complete a WebAuthn registration ceremony by validating the client request and saving the new credential 

WebAuthnRegisterCompleteRequest request An object containing data necessary for completing the registration ceremony

func (*FusionAuthClient) CreateAPIKey 

func (c *FusionAuthClient) CreateAPIKey(keyId string, request APIKeyRequest) (*APIKeyResponse, *Errors, error)

CreateAPIKey Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key.

If an API key is locked to a tenant, it can only create API Keys for that same tenant. 

string keyId (Optional) The unique Id of the API key. If not provided a secure random Id will be generated.
APIKeyRequest request The request object that contains all the information needed to create the APIKey.

func (*FusionAuthClient) CreateAPIKeyWithContext 

func (c *FusionAuthClient) CreateAPIKeyWithContext(ctx context.Context, keyId string, request APIKeyRequest) (*APIKeyResponse, *Errors, error)

CreateAPIKeyWithContext Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key.

If an API key is locked to a tenant, it can only create API Keys for that same tenant. 

string keyId (Optional) The unique Id of the API key. If not provided a secure random Id will be generated.
APIKeyRequest request The request object that contains all the information needed to create the APIKey.

func (*FusionAuthClient) CreateApplication 

func (c *FusionAuthClient) CreateApplication(applicationId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

CreateApplication Creates an application. You can optionally specify an Id for the application, if not provided one will be generated. 

string applicationId (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
ApplicationRequest request The request object that contains all the information used to create the application.

func (*FusionAuthClient) CreateApplicationRole 

func (c *FusionAuthClient) CreateApplicationRole(applicationId string, roleId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

CreateApplicationRole Creates a new role for an application. You must specify the Id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated. 

string applicationId The Id of the application to create the role on.
string roleId (Optional) The Id of the role. If not provided a secure random UUID will be generated.
ApplicationRequest request The request object that contains all the information used to create the application role.

func (*FusionAuthClient) CreateApplicationRoleWithContext 

func (c *FusionAuthClient) CreateApplicationRoleWithContext(ctx context.Context, applicationId string, roleId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

CreateApplicationRoleWithContext Creates a new role for an application. You must specify the Id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated. 

string applicationId The Id of the application to create the role on.
string roleId (Optional) The Id of the role. If not provided a secure random UUID will be generated.
ApplicationRequest request The request object that contains all the information used to create the application role.

func (*FusionAuthClient) CreateApplicationWithContext 

func (c *FusionAuthClient) CreateApplicationWithContext(ctx context.Context, applicationId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

CreateApplicationWithContext Creates an application. You can optionally specify an Id for the application, if not provided one will be generated. 

string applicationId (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
ApplicationRequest request The request object that contains all the information used to create the application.

func (*FusionAuthClient) CreateAuditLog 

func (c *FusionAuthClient) CreateAuditLog(request AuditLogRequest) (*AuditLogResponse, *Errors, error)

CreateAuditLog Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically written to the audit log. However, if you are accessing the API, you must write the audit logs yourself. 

AuditLogRequest request The request object that contains all the information used to create the audit log entry.

func (*FusionAuthClient) CreateAuditLogWithContext 

func (c *FusionAuthClient) CreateAuditLogWithContext(ctx context.Context, request AuditLogRequest) (*AuditLogResponse, *Errors, error)

CreateAuditLogWithContext Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically written to the audit log. However, if you are accessing the API, you must write the audit logs yourself. 

AuditLogRequest request The request object that contains all the information used to create the audit log entry.

func (*FusionAuthClient) CreateConnector 

func (c *FusionAuthClient) CreateConnector(connectorId string, request ConnectorRequest) (*ConnectorResponse, *Errors, error)

CreateConnector Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated. 

string connectorId (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
ConnectorRequest request The request object that contains all the information used to create the connector.

func (*FusionAuthClient) CreateConnectorWithContext 

func (c *FusionAuthClient) CreateConnectorWithContext(ctx context.Context, connectorId string, request ConnectorRequest) (*ConnectorResponse, *Errors, error)

CreateConnectorWithContext Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated. 

string connectorId (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
ConnectorRequest request The request object that contains all the information used to create the connector.

func (*FusionAuthClient) CreateConsent 

func (c *FusionAuthClient) CreateConsent(consentId string, request ConsentRequest) (*ConsentResponse, *Errors, error)

CreateConsent Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated. 

string consentId (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
ConsentRequest request The request object that contains all the information used to create the consent.

func (*FusionAuthClient) CreateConsentWithContext 

func (c *FusionAuthClient) CreateConsentWithContext(ctx context.Context, consentId string, request ConsentRequest) (*ConsentResponse, *Errors, error)

CreateConsentWithContext Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated. 

string consentId (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
ConsentRequest request The request object that contains all the information used to create the consent.

func (*FusionAuthClient) CreateEmailTemplate 

func (c *FusionAuthClient) CreateEmailTemplate(emailTemplateId string, request EmailTemplateRequest) (*EmailTemplateResponse, *Errors, error)

CreateEmailTemplate Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated. 

string emailTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
EmailTemplateRequest request The request object that contains all the information used to create the email template.

func (*FusionAuthClient) CreateEmailTemplateWithContext 

func (c *FusionAuthClient) CreateEmailTemplateWithContext(ctx context.Context, emailTemplateId string, request EmailTemplateRequest) (*EmailTemplateResponse, *Errors, error)

CreateEmailTemplateWithContext Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated. 

string emailTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
EmailTemplateRequest request The request object that contains all the information used to create the email template.

func (*FusionAuthClient) CreateEntity 

func (c *FusionAuthClient) CreateEntity(entityId string, request EntityRequest) (*EntityResponse, *Errors, error)

CreateEntity Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated. 

string entityId (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
EntityRequest request The request object that contains all the information used to create the Entity.

func (*FusionAuthClient) CreateEntityType 

func (c *FusionAuthClient) CreateEntityType(entityTypeId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

CreateEntityType Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated. 

string entityTypeId (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
EntityTypeRequest request The request object that contains all the information used to create the Entity Type.

func (*FusionAuthClient) CreateEntityTypePermission 

func (c *FusionAuthClient) CreateEntityTypePermission(entityTypeId string, permissionId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

CreateEntityTypePermission Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated. 

string entityTypeId The Id of the entity type to create the permission on.
string permissionId (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
EntityTypeRequest request The request object that contains all the information used to create the permission.

func (*FusionAuthClient) CreateEntityTypePermissionWithContext 

func (c *FusionAuthClient) CreateEntityTypePermissionWithContext(ctx context.Context, entityTypeId string, permissionId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

CreateEntityTypePermissionWithContext Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated. 

string entityTypeId The Id of the entity type to create the permission on.
string permissionId (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
EntityTypeRequest request The request object that contains all the information used to create the permission.

func (*FusionAuthClient) CreateEntityTypeWithContext 

func (c *FusionAuthClient) CreateEntityTypeWithContext(ctx context.Context, entityTypeId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

CreateEntityTypeWithContext Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated. 

string entityTypeId (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
EntityTypeRequest request The request object that contains all the information used to create the Entity Type.

func (*FusionAuthClient) CreateEntityWithContext 

func (c *FusionAuthClient) CreateEntityWithContext(ctx context.Context, entityId string, request EntityRequest) (*EntityResponse, *Errors, error)

CreateEntityWithContext Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated. 

string entityId (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
EntityRequest request The request object that contains all the information used to create the Entity.

func (*FusionAuthClient) CreateFamily 

func (c *FusionAuthClient) CreateFamily(familyId string, request FamilyRequest) (*FamilyResponse, *Errors, error)

CreateFamily Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the family, if not provided one will be generated. 

string familyId (Optional) The Id for the family. If not provided a secure random UUID will be generated.
FamilyRequest request The request object that contains all the information used to create the family.

func (*FusionAuthClient) CreateFamilyWithContext 

func (c *FusionAuthClient) CreateFamilyWithContext(ctx context.Context, familyId string, request FamilyRequest) (*FamilyResponse, *Errors, error)

CreateFamilyWithContext Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the family, if not provided one will be generated. 

string familyId (Optional) The Id for the family. If not provided a secure random UUID will be generated.
FamilyRequest request The request object that contains all the information used to create the family.

func (*FusionAuthClient) CreateForm 

func (c *FusionAuthClient) CreateForm(formId string, request FormRequest) (*FormResponse, *Errors, error)

CreateForm Creates a form. You can optionally specify an Id for the form, if not provided one will be generated. 

string formId (Optional) The Id for the form. If not provided a secure random UUID will be generated.
FormRequest request The request object that contains all the information used to create the form.

func (*FusionAuthClient) CreateFormField 

func (c *FusionAuthClient) CreateFormField(fieldId string, request FormFieldRequest) (*FormFieldResponse, *Errors, error)

CreateFormField Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated. 

string fieldId (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
FormFieldRequest request The request object that contains all the information used to create the form field.

func (*FusionAuthClient) CreateFormFieldWithContext 

func (c *FusionAuthClient) CreateFormFieldWithContext(ctx context.Context, fieldId string, request FormFieldRequest) (*FormFieldResponse, *Errors, error)

CreateFormFieldWithContext Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated. 

string fieldId (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
FormFieldRequest request The request object that contains all the information used to create the form field.

func (*FusionAuthClient) CreateFormWithContext 

func (c *FusionAuthClient) CreateFormWithContext(ctx context.Context, formId string, request FormRequest) (*FormResponse, *Errors, error)

CreateFormWithContext Creates a form. You can optionally specify an Id for the form, if not provided one will be generated. 

string formId (Optional) The Id for the form. If not provided a secure random UUID will be generated.
FormRequest request The request object that contains all the information used to create the form.

func (*FusionAuthClient) CreateGroup 

func (c *FusionAuthClient) CreateGroup(groupId string, request GroupRequest) (*GroupResponse, *Errors, error)

CreateGroup Creates a group. You can optionally specify an Id for the group, if not provided one will be generated. 

string groupId (Optional) The Id for the group. If not provided a secure random UUID will be generated.
GroupRequest request The request object that contains all the information used to create the group.

func (*FusionAuthClient) CreateGroupMembers 

func (c *FusionAuthClient) CreateGroupMembers(request MemberRequest) (*MemberResponse, *Errors, error)

CreateGroupMembers Creates a member in a group. 

MemberRequest request The request object that contains all the information used to create the group member(s).

func (*FusionAuthClient) CreateGroupMembersWithContext 

func (c *FusionAuthClient) CreateGroupMembersWithContext(ctx context.Context, request MemberRequest) (*MemberResponse, *Errors, error)

CreateGroupMembersWithContext Creates a member in a group. 

MemberRequest request The request object that contains all the information used to create the group member(s).

func (*FusionAuthClient) CreateGroupWithContext 

func (c *FusionAuthClient) CreateGroupWithContext(ctx context.Context, groupId string, request GroupRequest) (*GroupResponse, *Errors, error)

CreateGroupWithContext Creates a group. You can optionally specify an Id for the group, if not provided one will be generated. 

string groupId (Optional) The Id for the group. If not provided a secure random UUID will be generated.
GroupRequest request The request object that contains all the information used to create the group.

func (*FusionAuthClient) CreateIPAccessControlList 

func (c *FusionAuthClient) CreateIPAccessControlList(accessControlListId string, request IPAccessControlListRequest) (*IPAccessControlListResponse, *Errors, error)

CreateIPAccessControlList Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated. 

string accessControlListId (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
IPAccessControlListRequest request The request object that contains all the information used to create the IP Access Control List.

func (*FusionAuthClient) CreateIPAccessControlListWithContext 

func (c *FusionAuthClient) CreateIPAccessControlListWithContext(ctx context.Context, accessControlListId string, request IPAccessControlListRequest) (*IPAccessControlListResponse, *Errors, error)

CreateIPAccessControlListWithContext Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated. 

string accessControlListId (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
IPAccessControlListRequest request The request object that contains all the information used to create the IP Access Control List.

func (*FusionAuthClient) CreateLambda 

func (c *FusionAuthClient) CreateLambda(lambdaId string, request LambdaRequest) (*LambdaResponse, *Errors, error)

CreateLambda Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated. 

string lambdaId (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
LambdaRequest request The request object that contains all the information used to create the lambda.

func (*FusionAuthClient) CreateLambdaWithContext 

func (c *FusionAuthClient) CreateLambdaWithContext(ctx context.Context, lambdaId string, request LambdaRequest) (*LambdaResponse, *Errors, error)

CreateLambdaWithContext Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated. 

string lambdaId (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
LambdaRequest request The request object that contains all the information used to create the lambda.

func (*FusionAuthClient) CreateMessageTemplate 

func (c *FusionAuthClient) CreateMessageTemplate(messageTemplateId string, request MessageTemplateRequest) (*MessageTemplateResponse, *Errors, error)

CreateMessageTemplate Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated. 

string messageTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
MessageTemplateRequest request The request object that contains all the information used to create the message template.

func (*FusionAuthClient) CreateMessageTemplateWithContext 

func (c *FusionAuthClient) CreateMessageTemplateWithContext(ctx context.Context, messageTemplateId string, request MessageTemplateRequest) (*MessageTemplateResponse, *Errors, error)

CreateMessageTemplateWithContext Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated. 

string messageTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
MessageTemplateRequest request The request object that contains all the information used to create the message template.

func (*FusionAuthClient) CreateMessenger 

func (c *FusionAuthClient) CreateMessenger(messengerId string, request MessengerRequest) (*MessengerResponse, *Errors, error)

CreateMessenger Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated. 

string messengerId (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
MessengerRequest request The request object that contains all the information used to create the messenger.

func (*FusionAuthClient) CreateMessengerWithContext 

func (c *FusionAuthClient) CreateMessengerWithContext(ctx context.Context, messengerId string, request MessengerRequest) (*MessengerResponse, *Errors, error)

CreateMessengerWithContext Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated. 

string messengerId (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
MessengerRequest request The request object that contains all the information used to create the messenger.

func (*FusionAuthClient) CreateOAuthScope 

func (c *FusionAuthClient) CreateOAuthScope(applicationId string, scopeId string, request ApplicationOAuthScopeRequest) (*ApplicationOAuthScopeResponse, *Errors, error)

CreateOAuthScope Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated. 

string applicationId The Id of the application to create the OAuth scope on.
string scopeId (Optional) The Id of the OAuth scope. If not provided a secure random UUID will be generated.
ApplicationOAuthScopeRequest request The request object that contains all the information used to create the OAuth OAuth scope.

func (*FusionAuthClient) CreateOAuthScopeWithContext 

func (c *FusionAuthClient) CreateOAuthScopeWithContext(ctx context.Context, applicationId string, scopeId string, request ApplicationOAuthScopeRequest) (*ApplicationOAuthScopeResponse, *Errors, error)

CreateOAuthScopeWithContext Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated. 

string applicationId The Id of the application to create the OAuth scope on.
string scopeId (Optional) The Id of the OAuth scope. If not provided a secure random UUID will be generated.
ApplicationOAuthScopeRequest request The request object that contains all the information used to create the OAuth OAuth scope.

func (*FusionAuthClient) CreateTenant 

func (c *FusionAuthClient) CreateTenant(tenantId string, request TenantRequest) (*TenantResponse, *Errors, error)

CreateTenant Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated. 

string tenantId (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
TenantRequest request The request object that contains all the information used to create the tenant.

func (*FusionAuthClient) CreateTenantWithContext 

func (c *FusionAuthClient) CreateTenantWithContext(ctx context.Context, tenantId string, request TenantRequest) (*TenantResponse, *Errors, error)

CreateTenantWithContext Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated. 

string tenantId (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
TenantRequest request The request object that contains all the information used to create the tenant.

func (*FusionAuthClient) CreateTheme 

func (c *FusionAuthClient) CreateTheme(themeId string, request ThemeRequest) (*ThemeResponse, *Errors, error)

CreateTheme Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated. 

string themeId (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
ThemeRequest request The request object that contains all the information used to create the theme.

func (*FusionAuthClient) CreateThemeWithContext 

func (c *FusionAuthClient) CreateThemeWithContext(ctx context.Context, themeId string, request ThemeRequest) (*ThemeResponse, *Errors, error)

CreateThemeWithContext Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated. 

string themeId (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
ThemeRequest request The request object that contains all the information used to create the theme.

func (*FusionAuthClient) CreateUser 

func (c *FusionAuthClient) CreateUser(userId string, request UserRequest) (*UserResponse, *Errors, error)

CreateUser Creates a user. You can optionally specify an Id for the user, if not provided one will be generated. 

string userId (Optional) The Id for the user. If not provided a secure random UUID will be generated.
UserRequest request The request object that contains all the information used to create the user.

func (*FusionAuthClient) CreateUserAction 

func (c *FusionAuthClient) CreateUserAction(userActionId string, request UserActionRequest) (*UserActionResponse, *Errors, error)

CreateUserAction Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user. 

string userActionId (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
UserActionRequest request The request object that contains all the information used to create the user action.

func (*FusionAuthClient) CreateUserActionReason 

func (c *FusionAuthClient) CreateUserActionReason(userActionReasonId string, request UserActionReasonRequest) (*UserActionReasonResponse, *Errors, error)

CreateUserActionReason Creates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action reason can be used. 

string userActionReasonId (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
UserActionReasonRequest request The request object that contains all the information used to create the user action reason.

func (*FusionAuthClient) CreateUserActionReasonWithContext 

func (c *FusionAuthClient) CreateUserActionReasonWithContext(ctx context.Context, userActionReasonId string, request UserActionReasonRequest) (*UserActionReasonResponse, *Errors, error)

CreateUserActionReasonWithContext Creates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action reason can be used. 

string userActionReasonId (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
UserActionReasonRequest request The request object that contains all the information used to create the user action reason.

func (*FusionAuthClient) CreateUserActionWithContext 

func (c *FusionAuthClient) CreateUserActionWithContext(ctx context.Context, userActionId string, request UserActionRequest) (*UserActionResponse, *Errors, error)

CreateUserActionWithContext Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user. 

string userActionId (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
UserActionRequest request The request object that contains all the information used to create the user action.

func (*FusionAuthClient) CreateUserConsent 

func (c *FusionAuthClient) CreateUserConsent(userConsentId string, request UserConsentRequest) (*UserConsentResponse, *Errors, error)

CreateUserConsent Creates a single User consent. 

string userConsentId (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.
UserConsentRequest request The request that contains the user consent information.

func (*FusionAuthClient) CreateUserConsentWithContext 

func (c *FusionAuthClient) CreateUserConsentWithContext(ctx context.Context, userConsentId string, request UserConsentRequest) (*UserConsentResponse, *Errors, error)

CreateUserConsentWithContext Creates a single User consent. 

string userConsentId (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.
UserConsentRequest request The request that contains the user consent information.

func (c *FusionAuthClient) CreateUserLink(request IdentityProviderLinkRequest) (*IdentityProviderLinkResponse, *Errors, error)

CreateUserLink Link an external user from a 3rd party identity provider to a FusionAuth user. 

IdentityProviderLinkRequest request The request object that contains all the information used to link the FusionAuth user.

func (*FusionAuthClient) CreateUserLinkWithContext 

func (c *FusionAuthClient) CreateUserLinkWithContext(ctx context.Context, request IdentityProviderLinkRequest) (*IdentityProviderLinkResponse, *Errors, error)

CreateUserLinkWithContext Link an external user from a 3rd party identity provider to a FusionAuth user. 

IdentityProviderLinkRequest request The request object that contains all the information used to link the FusionAuth user.

func (*FusionAuthClient) CreateUserWithContext 

func (c *FusionAuthClient) CreateUserWithContext(ctx context.Context, userId string, request UserRequest) (*UserResponse, *Errors, error)

CreateUserWithContext Creates a user. You can optionally specify an Id for the user, if not provided one will be generated. 

string userId (Optional) The Id for the user. If not provided a secure random UUID will be generated.
UserRequest request The request object that contains all the information used to create the user.

func (*FusionAuthClient) CreateWebhook 

func (c *FusionAuthClient) CreateWebhook(webhookId string, request WebhookRequest) (*WebhookResponse, *Errors, error)

CreateWebhook Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated. 

string webhookId (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
WebhookRequest request The request object that contains all the information used to create the webhook.

func (*FusionAuthClient) CreateWebhookWithContext 

func (c *FusionAuthClient) CreateWebhookWithContext(ctx context.Context, webhookId string, request WebhookRequest) (*WebhookResponse, *Errors, error)

CreateWebhookWithContext Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated. 

string webhookId (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
WebhookRequest request The request object that contains all the information used to create the webhook.

func (*FusionAuthClient) DeactivateApplication 

func (c *FusionAuthClient) DeactivateApplication(applicationId string) (*BaseHTTPResponse, *Errors, error)

DeactivateApplication Deactivates the application with the given Id. 

string applicationId The Id of the application to deactivate.

func (*FusionAuthClient) DeactivateApplicationWithContext 

func (c *FusionAuthClient) DeactivateApplicationWithContext(ctx context.Context, applicationId string) (*BaseHTTPResponse, *Errors, error)

DeactivateApplicationWithContext Deactivates the application with the given Id. 

string applicationId The Id of the application to deactivate.

func (*FusionAuthClient) DeactivateReactor 

func (c *FusionAuthClient) DeactivateReactor() (*BaseHTTPResponse, error)

DeactivateReactor Deactivates the FusionAuth Reactor.

func (*FusionAuthClient) DeactivateReactorWithContext 

func (c *FusionAuthClient) DeactivateReactorWithContext(ctx context.Context) (*BaseHTTPResponse, error)

DeactivateReactorWithContext Deactivates the FusionAuth Reactor.

func (*FusionAuthClient) DeactivateUser 

func (c *FusionAuthClient) DeactivateUser(userId string) (*BaseHTTPResponse, *Errors, error)

DeactivateUser Deactivates the user with the given Id. 

string userId The Id of the user to deactivate.

func (*FusionAuthClient) DeactivateUserAction 

func (c *FusionAuthClient) DeactivateUserAction(userActionId string) (*BaseHTTPResponse, *Errors, error)

DeactivateUserAction Deactivates the user action with the given Id. 

string userActionId The Id of the user action to deactivate.

func (*FusionAuthClient) DeactivateUserActionWithContext 

func (c *FusionAuthClient) DeactivateUserActionWithContext(ctx context.Context, userActionId string) (*BaseHTTPResponse, *Errors, error)

DeactivateUserActionWithContext Deactivates the user action with the given Id. 

string userActionId The Id of the user action to deactivate.

func (*FusionAuthClient) DeactivateUserWithContext 

func (c *FusionAuthClient) DeactivateUserWithContext(ctx context.Context, userId string) (*BaseHTTPResponse, *Errors, error)

DeactivateUserWithContext Deactivates the user with the given Id. 

string userId The Id of the user to deactivate.

func (*FusionAuthClient) DeactivateUsers deprecated 

func (c *FusionAuthClient) DeactivateUsers(userIds []string) (*UserDeleteResponse, *Errors, error)

DeactivateUsers Deactivates the users with the given ids. 

[]string userIds The ids of the users to deactivate.

Deprecated: This method has been renamed to DeactivateUsersByIds, use that method instead.

func (*FusionAuthClient) DeactivateUsersByIds 

func (c *FusionAuthClient) DeactivateUsersByIds(userIds []string) (*UserDeleteResponse, *Errors, error)

DeactivateUsersByIds Deactivates the users with the given ids. 

[]string userIds The ids of the users to deactivate.

func (*FusionAuthClient) DeactivateUsersByIdsWithContext 

func (c *FusionAuthClient) DeactivateUsersByIdsWithContext(ctx context.Context, userIds []string) (*UserDeleteResponse, *Errors, error)

DeactivateUsersByIdsWithContext Deactivates the users with the given ids. 

[]string userIds The ids of the users to deactivate.

func (*FusionAuthClient) DeactivateUsersWithContext deprecated 

func (c *FusionAuthClient) DeactivateUsersWithContext(ctx context.Context, userIds []string) (*UserDeleteResponse, *Errors, error)

DeactivateUsersWithContext Deactivates the users with the given ids. 

[]string userIds The ids of the users to deactivate.

Deprecated: This method has been renamed to DeactivateUsersByIdsWithContext, use that method instead.

func (*FusionAuthClient) DeleteAPIKey 

func (c *FusionAuthClient) DeleteAPIKey(keyId string) (*BaseHTTPResponse, *Errors, error)

DeleteAPIKey Deletes the API key for the given Id. 

string keyId The Id of the authentication API key to delete.

func (*FusionAuthClient) DeleteAPIKeyWithContext 

func (c *FusionAuthClient) DeleteAPIKeyWithContext(ctx context.Context, keyId string) (*BaseHTTPResponse, *Errors, error)

DeleteAPIKeyWithContext Deletes the API key for the given Id. 

string keyId The Id of the authentication API key to delete.

func (*FusionAuthClient) DeleteApplication 

func (c *FusionAuthClient) DeleteApplication(applicationId string) (*BaseHTTPResponse, *Errors, error)

DeleteApplication Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will delete the application, any registrations for that application, metrics and reports for the application, all the roles for the application, and any other data associated with the application. This operation could take a very long time, depending on the amount of data in your database. 

string applicationId The Id of the application to delete.

func (*FusionAuthClient) DeleteApplicationRole 

func (c *FusionAuthClient) DeleteApplicationRole(applicationId string, roleId string) (*BaseHTTPResponse, *Errors, error)

DeleteApplicationRole Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given role from all users that had it. 

string applicationId The Id of the application that the role belongs to.
string roleId The Id of the role to delete.

func (*FusionAuthClient) DeleteApplicationRoleWithContext 

func (c *FusionAuthClient) DeleteApplicationRoleWithContext(ctx context.Context, applicationId string, roleId string) (*BaseHTTPResponse, *Errors, error)

DeleteApplicationRoleWithContext Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given role from all users that had it. 

string applicationId The Id of the application that the role belongs to.
string roleId The Id of the role to delete.

func (*FusionAuthClient) DeleteApplicationWithContext 

func (c *FusionAuthClient) DeleteApplicationWithContext(ctx context.Context, applicationId string) (*BaseHTTPResponse, *Errors, error)

DeleteApplicationWithContext Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will delete the application, any registrations for that application, metrics and reports for the application, all the roles for the application, and any other data associated with the application. This operation could take a very long time, depending on the amount of data in your database. 

string applicationId The Id of the application to delete.

func (*FusionAuthClient) DeleteConnector 

func (c *FusionAuthClient) DeleteConnector(connectorId string) (*BaseHTTPResponse, *Errors, error)

DeleteConnector Deletes the connector for the given Id. 

string connectorId The Id of the connector to delete.

func (*FusionAuthClient) DeleteConnectorWithContext 

func (c *FusionAuthClient) DeleteConnectorWithContext(ctx context.Context, connectorId string) (*BaseHTTPResponse, *Errors, error)

DeleteConnectorWithContext Deletes the connector for the given Id. 

string connectorId The Id of the connector to delete.

func (*FusionAuthClient) DeleteConsent 

func (c *FusionAuthClient) DeleteConsent(consentId string) (*BaseHTTPResponse, *Errors, error)

DeleteConsent Deletes the consent for the given Id. 

string consentId The Id of the consent to delete.

func (*FusionAuthClient) DeleteConsentWithContext 

func (c *FusionAuthClient) DeleteConsentWithContext(ctx context.Context, consentId string) (*BaseHTTPResponse, *Errors, error)

DeleteConsentWithContext Deletes the consent for the given Id. 

string consentId The Id of the consent to delete.

func (*FusionAuthClient) DeleteEmailTemplate 

func (c *FusionAuthClient) DeleteEmailTemplate(emailTemplateId string) (*BaseHTTPResponse, *Errors, error)

DeleteEmailTemplate Deletes the email template for the given Id. 

string emailTemplateId The Id of the email template to delete.

func (*FusionAuthClient) DeleteEmailTemplateWithContext 

func (c *FusionAuthClient) DeleteEmailTemplateWithContext(ctx context.Context, emailTemplateId string) (*BaseHTTPResponse, *Errors, error)

DeleteEmailTemplateWithContext Deletes the email template for the given Id. 

string emailTemplateId The Id of the email template to delete.

func (*FusionAuthClient) DeleteEntity 

func (c *FusionAuthClient) DeleteEntity(entityId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntity Deletes the Entity for the given Id. 

string entityId The Id of the Entity to delete.

func (*FusionAuthClient) DeleteEntityGrant 

func (c *FusionAuthClient) DeleteEntityGrant(entityId string, recipientEntityId string, userId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityGrant Deletes an Entity Grant for the given User or Entity. 

string entityId The Id of the Entity that the Entity Grant is being deleted for.
string recipientEntityId (Optional) The Id of the Entity that the Entity Grant is for.
string userId (Optional) The Id of the User that the Entity Grant is for.

func (*FusionAuthClient) DeleteEntityGrantWithContext 

func (c *FusionAuthClient) DeleteEntityGrantWithContext(ctx context.Context, entityId string, recipientEntityId string, userId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityGrantWithContext Deletes an Entity Grant for the given User or Entity. 

string entityId The Id of the Entity that the Entity Grant is being deleted for.
string recipientEntityId (Optional) The Id of the Entity that the Entity Grant is for.
string userId (Optional) The Id of the User that the Entity Grant is for.

func (*FusionAuthClient) DeleteEntityType 

func (c *FusionAuthClient) DeleteEntityType(entityTypeId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityType Deletes the Entity Type for the given Id. 

string entityTypeId The Id of the Entity Type to delete.

func (*FusionAuthClient) DeleteEntityTypePermission 

func (c *FusionAuthClient) DeleteEntityTypePermission(entityTypeId string, permissionId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityTypePermission Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given permission from all grants that had it. 

string entityTypeId The Id of the entityType the the permission belongs to.
string permissionId The Id of the permission to delete.

func (*FusionAuthClient) DeleteEntityTypePermissionWithContext 

func (c *FusionAuthClient) DeleteEntityTypePermissionWithContext(ctx context.Context, entityTypeId string, permissionId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityTypePermissionWithContext Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given permission from all grants that had it. 

string entityTypeId The Id of the entityType the the permission belongs to.
string permissionId The Id of the permission to delete.

func (*FusionAuthClient) DeleteEntityTypeWithContext 

func (c *FusionAuthClient) DeleteEntityTypeWithContext(ctx context.Context, entityTypeId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityTypeWithContext Deletes the Entity Type for the given Id. 

string entityTypeId The Id of the Entity Type to delete.

func (*FusionAuthClient) DeleteEntityWithContext 

func (c *FusionAuthClient) DeleteEntityWithContext(ctx context.Context, entityId string) (*BaseHTTPResponse, *Errors, error)

DeleteEntityWithContext Deletes the Entity for the given Id. 

string entityId The Id of the Entity to delete.

func (*FusionAuthClient) DeleteForm 

func (c *FusionAuthClient) DeleteForm(formId string) (*BaseHTTPResponse, *Errors, error)

DeleteForm Deletes the form for the given Id. 

string formId The Id of the form to delete.

func (*FusionAuthClient) DeleteFormField 

func (c *FusionAuthClient) DeleteFormField(fieldId string) (*BaseHTTPResponse, *Errors, error)

DeleteFormField Deletes the form field for the given Id. 

string fieldId The Id of the form field to delete.

func (*FusionAuthClient) DeleteFormFieldWithContext 

func (c *FusionAuthClient) DeleteFormFieldWithContext(ctx context.Context, fieldId string) (*BaseHTTPResponse, *Errors, error)

DeleteFormFieldWithContext Deletes the form field for the given Id. 

string fieldId The Id of the form field to delete.

func (*FusionAuthClient) DeleteFormWithContext 

func (c *FusionAuthClient) DeleteFormWithContext(ctx context.Context, formId string) (*BaseHTTPResponse, *Errors, error)

DeleteFormWithContext Deletes the form for the given Id. 

string formId The Id of the form to delete.

func (*FusionAuthClient) DeleteGroup 

func (c *FusionAuthClient) DeleteGroup(groupId string) (*BaseHTTPResponse, *Errors, error)

DeleteGroup Deletes the group for the given Id. 

string groupId The Id of the group to delete.

func (*FusionAuthClient) DeleteGroupMembers 

func (c *FusionAuthClient) DeleteGroupMembers(request MemberDeleteRequest) (*BaseHTTPResponse, *Errors, error)

DeleteGroupMembers Removes users as members of a group. 

MemberDeleteRequest request The member request that contains all the information used to remove members to the group.

func (*FusionAuthClient) DeleteGroupMembersWithContext 

func (c *FusionAuthClient) DeleteGroupMembersWithContext(ctx context.Context, request MemberDeleteRequest) (*BaseHTTPResponse, *Errors, error)

DeleteGroupMembersWithContext Removes users as members of a group. 

MemberDeleteRequest request The member request that contains all the information used to remove members to the group.

func (*FusionAuthClient) DeleteGroupWithContext 

func (c *FusionAuthClient) DeleteGroupWithContext(ctx context.Context, groupId string) (*BaseHTTPResponse, *Errors, error)

DeleteGroupWithContext Deletes the group for the given Id. 

string groupId The Id of the group to delete.

func (*FusionAuthClient) DeleteIPAccessControlList 

func (c *FusionAuthClient) DeleteIPAccessControlList(ipAccessControlListId string) (*BaseHTTPResponse, *Errors, error)

DeleteIPAccessControlList Deletes the IP Access Control List for the given Id. 

string ipAccessControlListId The Id of the IP Access Control List to delete.

func (*FusionAuthClient) DeleteIPAccessControlListWithContext 

func (c *FusionAuthClient) DeleteIPAccessControlListWithContext(ctx context.Context, ipAccessControlListId string) (*BaseHTTPResponse, *Errors, error)

DeleteIPAccessControlListWithContext Deletes the IP Access Control List for the given Id. 

string ipAccessControlListId The Id of the IP Access Control List to delete.

func (*FusionAuthClient) DeleteIdentityProvider 

func (c *FusionAuthClient) DeleteIdentityProvider(identityProviderId string) (*BaseHTTPResponse, *Errors, error)

DeleteIdentityProvider Deletes the identity provider for the given Id. 

string identityProviderId The Id of the identity provider to delete.

func (*FusionAuthClient) DeleteIdentityProviderWithContext 

func (c *FusionAuthClient) DeleteIdentityProviderWithContext(ctx context.Context, identityProviderId string) (*BaseHTTPResponse, *Errors, error)

DeleteIdentityProviderWithContext Deletes the identity provider for the given Id. 

string identityProviderId The Id of the identity provider to delete.

func (*FusionAuthClient) DeleteKey 

func (c *FusionAuthClient) DeleteKey(keyId string) (*BaseHTTPResponse, *Errors, error)

DeleteKey Deletes the key for the given Id. 

string keyId The Id of the key to delete.

func (*FusionAuthClient) DeleteKeyWithContext 

func (c *FusionAuthClient) DeleteKeyWithContext(ctx context.Context, keyId string) (*BaseHTTPResponse, *Errors, error)

DeleteKeyWithContext Deletes the key for the given Id. 

string keyId The Id of the key to delete.

func (*FusionAuthClient) DeleteLambda 

func (c *FusionAuthClient) DeleteLambda(lambdaId string) (*BaseHTTPResponse, *Errors, error)

DeleteLambda Deletes the lambda for the given Id. 

string lambdaId The Id of the lambda to delete.

func (*FusionAuthClient) DeleteLambdaWithContext 

func (c *FusionAuthClient) DeleteLambdaWithContext(ctx context.Context, lambdaId string) (*BaseHTTPResponse, *Errors, error)

DeleteLambdaWithContext Deletes the lambda for the given Id. 

string lambdaId The Id of the lambda to delete.

func (*FusionAuthClient) DeleteMessageTemplate 

func (c *FusionAuthClient) DeleteMessageTemplate(messageTemplateId string) (*BaseHTTPResponse, *Errors, error)

DeleteMessageTemplate Deletes the message template for the given Id. 

string messageTemplateId The Id of the message template to delete.

func (*FusionAuthClient) DeleteMessageTemplateWithContext 

func (c *FusionAuthClient) DeleteMessageTemplateWithContext(ctx context.Context, messageTemplateId string) (*BaseHTTPResponse, *Errors, error)

DeleteMessageTemplateWithContext Deletes the message template for the given Id. 

string messageTemplateId The Id of the message template to delete.

func (*FusionAuthClient) DeleteMessenger 

func (c *FusionAuthClient) DeleteMessenger(messengerId string) (*BaseHTTPResponse, *Errors, error)

DeleteMessenger Deletes the messenger for the given Id. 

string messengerId The Id of the messenger to delete.

func (*FusionAuthClient) DeleteMessengerWithContext 

func (c *FusionAuthClient) DeleteMessengerWithContext(ctx context.Context, messengerId string) (*BaseHTTPResponse, *Errors, error)

DeleteMessengerWithContext Deletes the messenger for the given Id. 

string messengerId The Id of the messenger to delete.

func (*FusionAuthClient) DeleteOAuthScope 

func (c *FusionAuthClient) DeleteOAuthScope(applicationId string, scopeId string) (*BaseHTTPResponse, *Errors, error)

DeleteOAuthScope Hard deletes a custom OAuth scope. OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application's unknown scope policy. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to delete.

func (*FusionAuthClient) DeleteOAuthScopeWithContext 

func (c *FusionAuthClient) DeleteOAuthScopeWithContext(ctx context.Context, applicationId string, scopeId string) (*BaseHTTPResponse, *Errors, error)

DeleteOAuthScopeWithContext Hard deletes a custom OAuth scope. OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application's unknown scope policy. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to delete.

func (*FusionAuthClient) DeleteRegistration 

func (c *FusionAuthClient) DeleteRegistration(userId string, applicationId string) (*BaseHTTPResponse, *Errors, error)

DeleteRegistration Deletes the user registration for the given user and application. 

string userId The Id of the user whose registration is being deleted.
string applicationId The Id of the application to remove the registration for.

func (*FusionAuthClient) DeleteRegistrationWithContext 

func (c *FusionAuthClient) DeleteRegistrationWithContext(ctx context.Context, userId string, applicationId string) (*BaseHTTPResponse, *Errors, error)

DeleteRegistrationWithContext Deletes the user registration for the given user and application. 

string userId The Id of the user whose registration is being deleted.
string applicationId The Id of the application to remove the registration for.

func (*FusionAuthClient) DeleteRegistrationWithRequest 

func (c *FusionAuthClient) DeleteRegistrationWithRequest(userId string, applicationId string, request RegistrationDeleteRequest) (*BaseHTTPResponse, *Errors, error)

DeleteRegistrationWithRequest Deletes the user registration for the given user and application along with the given JSON body that contains the event information. 

string userId The Id of the user whose registration is being deleted.
string applicationId The Id of the application to remove the registration for.
RegistrationDeleteRequest request The request body that contains the event information.

func (*FusionAuthClient) DeleteRegistrationWithRequestWithContext 

func (c *FusionAuthClient) DeleteRegistrationWithRequestWithContext(ctx context.Context, userId string, applicationId string, request RegistrationDeleteRequest) (*BaseHTTPResponse, *Errors, error)

DeleteRegistrationWithRequestWithContext Deletes the user registration for the given user and application along with the given JSON body that contains the event information. 

string userId The Id of the user whose registration is being deleted.
string applicationId The Id of the application to remove the registration for.
RegistrationDeleteRequest request The request body that contains the event information.

func (*FusionAuthClient) DeleteTenant 

func (c *FusionAuthClient) DeleteTenant(tenantId string) (*BaseHTTPResponse, *Errors, error)

DeleteTenant Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc). 

string tenantId The Id of the tenant to delete.

func (*FusionAuthClient) DeleteTenantAsync 

func (c *FusionAuthClient) DeleteTenantAsync(tenantId string) (*BaseHTTPResponse, *Errors, error)

DeleteTenantAsync Deletes the tenant for the given Id asynchronously. This method is helpful if you do not want to wait for the delete operation to complete. 

string tenantId The Id of the tenant to delete.

func (*FusionAuthClient) DeleteTenantAsyncWithContext 

func (c *FusionAuthClient) DeleteTenantAsyncWithContext(ctx context.Context, tenantId string) (*BaseHTTPResponse, *Errors, error)

DeleteTenantAsyncWithContext Deletes the tenant for the given Id asynchronously. This method is helpful if you do not want to wait for the delete operation to complete. 

string tenantId The Id of the tenant to delete.

func (*FusionAuthClient) DeleteTenantWithContext 

func (c *FusionAuthClient) DeleteTenantWithContext(ctx context.Context, tenantId string) (*BaseHTTPResponse, *Errors, error)

DeleteTenantWithContext Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc). 

string tenantId The Id of the tenant to delete.

func (*FusionAuthClient) DeleteTenantWithRequest 

func (c *FusionAuthClient) DeleteTenantWithRequest(tenantId string, request TenantDeleteRequest) (*BaseHTTPResponse, *Errors, error)

DeleteTenantWithRequest Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc). 

string tenantId The Id of the tenant to delete.
TenantDeleteRequest request The request object that contains all the information used to delete the user.

func (*FusionAuthClient) DeleteTenantWithRequestWithContext 

func (c *FusionAuthClient) DeleteTenantWithRequestWithContext(ctx context.Context, tenantId string, request TenantDeleteRequest) (*BaseHTTPResponse, *Errors, error)

DeleteTenantWithRequestWithContext Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc). 

string tenantId The Id of the tenant to delete.
TenantDeleteRequest request The request object that contains all the information used to delete the user.

func (*FusionAuthClient) DeleteTheme 

func (c *FusionAuthClient) DeleteTheme(themeId string) (*BaseHTTPResponse, *Errors, error)

DeleteTheme Deletes the theme for the given Id. 

string themeId The Id of the theme to delete.

func (*FusionAuthClient) DeleteThemeWithContext 

func (c *FusionAuthClient) DeleteThemeWithContext(ctx context.Context, themeId string) (*BaseHTTPResponse, *Errors, error)

DeleteThemeWithContext Deletes the theme for the given Id. 

string themeId The Id of the theme to delete.

func (*FusionAuthClient) DeleteUser 

func (c *FusionAuthClient) DeleteUser(userId string) (*BaseHTTPResponse, *Errors, error)

DeleteUser Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user. 

string userId The Id of the user to delete.

func (*FusionAuthClient) DeleteUserAction 

func (c *FusionAuthClient) DeleteUserAction(userActionId string) (*BaseHTTPResponse, *Errors, error)

DeleteUserAction Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users. 

string userActionId The Id of the user action to delete.

func (*FusionAuthClient) DeleteUserActionReason 

func (c *FusionAuthClient) DeleteUserActionReason(userActionReasonId string) (*BaseHTTPResponse, *Errors, error)

DeleteUserActionReason Deletes the user action reason for the given Id. 

string userActionReasonId The Id of the user action reason to delete.

func (*FusionAuthClient) DeleteUserActionReasonWithContext 

func (c *FusionAuthClient) DeleteUserActionReasonWithContext(ctx context.Context, userActionReasonId string) (*BaseHTTPResponse, *Errors, error)

DeleteUserActionReasonWithContext Deletes the user action reason for the given Id. 

string userActionReasonId The Id of the user action reason to delete.

func (*FusionAuthClient) DeleteUserActionWithContext 

func (c *FusionAuthClient) DeleteUserActionWithContext(ctx context.Context, userActionId string) (*BaseHTTPResponse, *Errors, error)

DeleteUserActionWithContext Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users. 

string userActionId The Id of the user action to delete.

func (c *FusionAuthClient) DeleteUserLink(identityProviderId string, identityProviderUserId string, userId string) (*IdentityProviderLinkResponse, *Errors, error)

DeleteUserLink Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user. 

string identityProviderId The unique Id of the identity provider.
string identityProviderUserId The unique Id of the user in the 3rd party identity provider to unlink.
string userId The unique Id of the FusionAuth user to unlink.

func (*FusionAuthClient) DeleteUserLinkWithContext 

func (c *FusionAuthClient) DeleteUserLinkWithContext(ctx context.Context, identityProviderId string, identityProviderUserId string, userId string) (*IdentityProviderLinkResponse, *Errors, error)

DeleteUserLinkWithContext Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user. 

string identityProviderId The unique Id of the identity provider.
string identityProviderUserId The unique Id of the user in the 3rd party identity provider to unlink.
string userId The unique Id of the FusionAuth user to unlink.

func (*FusionAuthClient) DeleteUserWithContext 

func (c *FusionAuthClient) DeleteUserWithContext(ctx context.Context, userId string) (*BaseHTTPResponse, *Errors, error)

DeleteUserWithContext Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user. 

string userId The Id of the user to delete.

func (*FusionAuthClient) DeleteUserWithRequest 

func (c *FusionAuthClient) DeleteUserWithRequest(userId string, request UserDeleteSingleRequest) (*BaseHTTPResponse, *Errors, error)

DeleteUserWithRequest Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the user. 

string userId The Id of the user to delete (required).
UserDeleteSingleRequest request The request object that contains all the information used to delete the user.

func (*FusionAuthClient) DeleteUserWithRequestWithContext 

func (c *FusionAuthClient) DeleteUserWithRequestWithContext(ctx context.Context, userId string, request UserDeleteSingleRequest) (*BaseHTTPResponse, *Errors, error)

DeleteUserWithRequestWithContext Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the user. 

string userId The Id of the user to delete (required).
UserDeleteSingleRequest request The request object that contains all the information used to delete the user.

func (*FusionAuthClient) DeleteUsers deprecated 

func (c *FusionAuthClient) DeleteUsers(request UserDeleteRequest) (*UserDeleteResponse, *Errors, error)

DeleteUsers Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users. 

UserDeleteRequest request The UserDeleteRequest.

Deprecated: This method has been renamed to DeleteUsersByQuery, use that method instead.

func (*FusionAuthClient) DeleteUsersByQuery 

func (c *FusionAuthClient) DeleteUsersByQuery(request UserDeleteRequest) (*UserDeleteResponse, *Errors, error)

DeleteUsersByQuery Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users. 

UserDeleteRequest request The UserDeleteRequest.

func (*FusionAuthClient) DeleteUsersByQueryWithContext 

func (c *FusionAuthClient) DeleteUsersByQueryWithContext(ctx context.Context, request UserDeleteRequest) (*UserDeleteResponse, *Errors, error)

DeleteUsersByQueryWithContext Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users. 

UserDeleteRequest request The UserDeleteRequest.

func (*FusionAuthClient) DeleteUsersWithContext deprecated 

func (c *FusionAuthClient) DeleteUsersWithContext(ctx context.Context, request UserDeleteRequest) (*UserDeleteResponse, *Errors, error)

DeleteUsersWithContext Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users. 

UserDeleteRequest request The UserDeleteRequest.

Deprecated: This method has been renamed to DeleteUsersByQueryWithContext, use that method instead.

func (*FusionAuthClient) DeleteWebAuthnCredential 

func (c *FusionAuthClient) DeleteWebAuthnCredential(id string) (*BaseHTTPResponse, *Errors, error)

DeleteWebAuthnCredential Deletes the WebAuthn credential for the given Id. 

string id The Id of the WebAuthn credential to delete.

func (*FusionAuthClient) DeleteWebAuthnCredentialWithContext 

func (c *FusionAuthClient) DeleteWebAuthnCredentialWithContext(ctx context.Context, id string) (*BaseHTTPResponse, *Errors, error)

DeleteWebAuthnCredentialWithContext Deletes the WebAuthn credential for the given Id. 

string id The Id of the WebAuthn credential to delete.

func (*FusionAuthClient) DeleteWebhook 

func (c *FusionAuthClient) DeleteWebhook(webhookId string) (*BaseHTTPResponse, *Errors, error)

DeleteWebhook Deletes the webhook for the given Id. 

string webhookId The Id of the webhook to delete.

func (*FusionAuthClient) DeleteWebhookWithContext 

func (c *FusionAuthClient) DeleteWebhookWithContext(ctx context.Context, webhookId string) (*BaseHTTPResponse, *Errors, error)

DeleteWebhookWithContext Deletes the webhook for the given Id. 

string webhookId The Id of the webhook to delete.

func (*FusionAuthClient) DisableTwoFactor 

func (c *FusionAuthClient) DisableTwoFactor(userId string, methodId string, code string) (*BaseHTTPResponse, *Errors, error)

DisableTwoFactor Disable two-factor authentication for a user. 

string userId The Id of the User for which you're disabling two-factor authentication.
string methodId The two-factor method identifier you wish to disable
string code The two-factor code used verify the the caller knows the two-factor secret.

func (*FusionAuthClient) DisableTwoFactorWithContext 

func (c *FusionAuthClient) DisableTwoFactorWithContext(ctx context.Context, userId string, methodId string, code string) (*BaseHTTPResponse, *Errors, error)

DisableTwoFactorWithContext Disable two-factor authentication for a user. 

string userId The Id of the User for which you're disabling two-factor authentication.
string methodId The two-factor method identifier you wish to disable
string code The two-factor code used verify the the caller knows the two-factor secret.

func (*FusionAuthClient) DisableTwoFactorWithRequest 

func (c *FusionAuthClient) DisableTwoFactorWithRequest(userId string, request TwoFactorDisableRequest) (*BaseHTTPResponse, *Errors, error)

DisableTwoFactorWithRequest Disable two-factor authentication for a user using a JSON body rather than URL parameters. 

string userId The Id of the User for which you're disabling two-factor authentication.
TwoFactorDisableRequest request The request information that contains the code and methodId along with any event information.

func (*FusionAuthClient) DisableTwoFactorWithRequestWithContext 

func (c *FusionAuthClient) DisableTwoFactorWithRequestWithContext(ctx context.Context, userId string, request TwoFactorDisableRequest) (*BaseHTTPResponse, *Errors, error)

DisableTwoFactorWithRequestWithContext Disable two-factor authentication for a user using a JSON body rather than URL parameters. 

string userId The Id of the User for which you're disabling two-factor authentication.
TwoFactorDisableRequest request The request information that contains the code and methodId along with any event information.

func (*FusionAuthClient) EnableTwoFactor 

func (c *FusionAuthClient) EnableTwoFactor(userId string, request TwoFactorRequest) (*TwoFactorResponse, *Errors, error)

EnableTwoFactor Enable two-factor authentication for a user. 

string userId The Id of the user to enable two-factor authentication.
TwoFactorRequest request The two-factor enable request information.

func (*FusionAuthClient) EnableTwoFactorWithContext 

func (c *FusionAuthClient) EnableTwoFactorWithContext(ctx context.Context, userId string, request TwoFactorRequest) (*TwoFactorResponse, *Errors, error)

EnableTwoFactorWithContext Enable two-factor authentication for a user. 

string userId The Id of the user to enable two-factor authentication.
TwoFactorRequest request The two-factor enable request information.

func (*FusionAuthClient) ExchangeOAuthCodeForAccessToken 

func (c *FusionAuthClient) ExchangeOAuthCodeForAccessToken(code string, clientId string, clientSecret string, redirectUri string) (*AccessToken, *OAuthError, error)

ExchangeOAuthCodeForAccessToken Exchanges an OAuth authorization code for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token. 

string code The authorization code returned on the /oauth2/authorize response.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value will be required if client authentication is enabled.
string redirectUri The URI to redirect to upon a successful request.

func (*FusionAuthClient) ExchangeOAuthCodeForAccessTokenUsingPKCE 

func (c *FusionAuthClient) ExchangeOAuthCodeForAccessTokenUsingPKCE(code string, clientId string, clientSecret string, redirectUri string, codeVerifier string) (*AccessToken, *OAuthError, error)

ExchangeOAuthCodeForAccessTokenUsingPKCE Exchanges an OAuth authorization code and code_verifier for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token. 

string code The authorization code returned on the /oauth2/authorize response.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
string redirectUri The URI to redirect to upon a successful request.
string codeVerifier The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.

func (*FusionAuthClient) ExchangeOAuthCodeForAccessTokenUsingPKCEWithContext 

func (c *FusionAuthClient) ExchangeOAuthCodeForAccessTokenUsingPKCEWithContext(ctx context.Context, code string, clientId string, clientSecret string, redirectUri string, codeVerifier string) (*AccessToken, *OAuthError, error)

ExchangeOAuthCodeForAccessTokenUsingPKCEWithContext Exchanges an OAuth authorization code and code_verifier for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token. 

string code The authorization code returned on the /oauth2/authorize response.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
string redirectUri The URI to redirect to upon a successful request.
string codeVerifier The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.

func (*FusionAuthClient) ExchangeOAuthCodeForAccessTokenWithContext 

func (c *FusionAuthClient) ExchangeOAuthCodeForAccessTokenWithContext(ctx context.Context, code string, clientId string, clientSecret string, redirectUri string) (*AccessToken, *OAuthError, error)

ExchangeOAuthCodeForAccessTokenWithContext Exchanges an OAuth authorization code for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token. 

string code The authorization code returned on the /oauth2/authorize response.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value will be required if client authentication is enabled.
string redirectUri The URI to redirect to upon a successful request.

func (*FusionAuthClient) ExchangeRefreshTokenForAccessToken 

func (c *FusionAuthClient) ExchangeRefreshTokenForAccessToken(refreshToken string, clientId string, clientSecret string, scope string, userCode string) (*AccessToken, *OAuthError, error)

ExchangeRefreshTokenForAccessToken Exchange a Refresh Token for an Access Token. If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token. 

string refreshToken The refresh token that you would like to use to exchange for an access token.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
string scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
string userCode (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.

func (*FusionAuthClient) ExchangeRefreshTokenForAccessTokenWithContext 

func (c *FusionAuthClient) ExchangeRefreshTokenForAccessTokenWithContext(ctx context.Context, refreshToken string, clientId string, clientSecret string, scope string, userCode string) (*AccessToken, *OAuthError, error)

ExchangeRefreshTokenForAccessTokenWithContext Exchange a Refresh Token for an Access Token. If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token. 

string refreshToken The refresh token that you would like to use to exchange for an access token.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
string scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
string userCode (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.

func (*FusionAuthClient) ExchangeRefreshTokenForJWT 

func (c *FusionAuthClient) ExchangeRefreshTokenForJWT(request RefreshRequest) (*JWTRefreshResponse, *Errors, error)

ExchangeRefreshTokenForJWT Exchange a refresh token for a new JWT. 

RefreshRequest request The refresh request.

func (*FusionAuthClient) ExchangeRefreshTokenForJWTWithContext 

func (c *FusionAuthClient) ExchangeRefreshTokenForJWTWithContext(ctx context.Context, request RefreshRequest) (*JWTRefreshResponse, *Errors, error)

ExchangeRefreshTokenForJWTWithContext Exchange a refresh token for a new JWT. 

RefreshRequest request The refresh request.

func (*FusionAuthClient) ExchangeUserCredentialsForAccessToken 

func (c *FusionAuthClient) ExchangeUserCredentialsForAccessToken(username string, password string, clientId string, clientSecret string, scope string, userCode string) (*AccessToken, *OAuthError, error)

ExchangeUserCredentialsForAccessToken Exchange User Credentials for a Token. If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token. 

string username The login identifier of the user. The login identifier can be either the email or the username.
string password The user’s password.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
string scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
string userCode (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.

func (*FusionAuthClient) ExchangeUserCredentialsForAccessTokenWithContext 

func (c *FusionAuthClient) ExchangeUserCredentialsForAccessTokenWithContext(ctx context.Context, username string, password string, clientId string, clientSecret string, scope string, userCode string) (*AccessToken, *OAuthError, error)

ExchangeUserCredentialsForAccessTokenWithContext Exchange User Credentials for a Token. If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token. 

string username The login identifier of the user. The login identifier can be either the email or the username.
string password The user’s password.
string clientId (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
This parameter is optional when Basic Authorization is used to authenticate this request.
string clientSecret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
string scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
string userCode (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.

func (*FusionAuthClient) ForgotPassword 

func (c *FusionAuthClient) ForgotPassword(request ForgotPasswordRequest) (*ForgotPasswordResponse, *Errors, error)

ForgotPassword Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password. 

ForgotPasswordRequest request The request that contains the information about the user so that they can be emailed.

func (*FusionAuthClient) ForgotPasswordWithContext 

func (c *FusionAuthClient) ForgotPasswordWithContext(ctx context.Context, request ForgotPasswordRequest) (*ForgotPasswordResponse, *Errors, error)

ForgotPasswordWithContext Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password. 

ForgotPasswordRequest request The request that contains the information about the user so that they can be emailed.

func (*FusionAuthClient) GenerateEmailVerificationId 

func (c *FusionAuthClient) GenerateEmailVerificationId(email string) (*VerifyEmailResponse, error)

GenerateEmailVerificationId Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system. 

string email The email address of the user that needs a new verification email.

func (*FusionAuthClient) GenerateEmailVerificationIdWithContext 

func (c *FusionAuthClient) GenerateEmailVerificationIdWithContext(ctx context.Context, email string) (*VerifyEmailResponse, error)

GenerateEmailVerificationIdWithContext Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system. 

string email The email address of the user that needs a new verification email.

func (*FusionAuthClient) GenerateKey 

func (c *FusionAuthClient) GenerateKey(keyId string, request KeyRequest) (*KeyResponse, *Errors, error)

GenerateKey Generate a new RSA or EC key pair or an HMAC secret. 

string keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
KeyRequest request The request object that contains all the information used to create the key.

func (*FusionAuthClient) GenerateKeyWithContext 

func (c *FusionAuthClient) GenerateKeyWithContext(ctx context.Context, keyId string, request KeyRequest) (*KeyResponse, *Errors, error)

GenerateKeyWithContext Generate a new RSA or EC key pair or an HMAC secret. 

string keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
KeyRequest request The request object that contains all the information used to create the key.

func (*FusionAuthClient) GenerateRegistrationVerificationId 

func (c *FusionAuthClient) GenerateRegistrationVerificationId(email string, applicationId string) (*VerifyRegistrationResponse, error)

GenerateRegistrationVerificationId Generate a new Application Registration Verification Id to be used with the Verify Registration API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system. 

string email The email address of the user that needs a new verification email.
string applicationId The Id of the application to be verified.

func (*FusionAuthClient) GenerateRegistrationVerificationIdWithContext 

func (c *FusionAuthClient) GenerateRegistrationVerificationIdWithContext(ctx context.Context, email string, applicationId string) (*VerifyRegistrationResponse, error)

GenerateRegistrationVerificationIdWithContext Generate a new Application Registration Verification Id to be used with the Verify Registration API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system. 

string email The email address of the user that needs a new verification email.
string applicationId The Id of the application to be verified.

func (*FusionAuthClient) GenerateTwoFactorRecoveryCodes 

func (c *FusionAuthClient) GenerateTwoFactorRecoveryCodes(userId string) (*TwoFactorRecoveryCodeResponse, *Errors, error)

GenerateTwoFactorRecoveryCodes Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes. 

string userId The Id of the user to generate new Two Factor recovery codes.

func (*FusionAuthClient) GenerateTwoFactorRecoveryCodesWithContext 

func (c *FusionAuthClient) GenerateTwoFactorRecoveryCodesWithContext(ctx context.Context, userId string) (*TwoFactorRecoveryCodeResponse, *Errors, error)

GenerateTwoFactorRecoveryCodesWithContext Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes. 

string userId The Id of the user to generate new Two Factor recovery codes.

func (*FusionAuthClient) GenerateTwoFactorSecret 

func (c *FusionAuthClient) GenerateTwoFactorSecret() (*SecretResponse, error)

GenerateTwoFactorSecret Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.

func (*FusionAuthClient) GenerateTwoFactorSecretUsingJWT 

func (c *FusionAuthClient) GenerateTwoFactorSecretUsingJWT(encodedJWT string) (*SecretResponse, error)

GenerateTwoFactorSecretUsingJWT Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) GenerateTwoFactorSecretUsingJWTWithContext 

func (c *FusionAuthClient) GenerateTwoFactorSecretUsingJWTWithContext(ctx context.Context, encodedJWT string) (*SecretResponse, error)

GenerateTwoFactorSecretUsingJWTWithContext Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) GenerateTwoFactorSecretWithContext 

func (c *FusionAuthClient) GenerateTwoFactorSecretWithContext(ctx context.Context) (*SecretResponse, error)

GenerateTwoFactorSecretWithContext Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.

func (*FusionAuthClient) IdentityProviderLogin 

func (c *FusionAuthClient) IdentityProviderLogin(request IdentityProviderLoginRequest) (*LoginResponse, *Errors, error)

IdentityProviderLogin Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems. 

IdentityProviderLoginRequest request The third-party login request that contains information from the third-party login
providers that FusionAuth uses to reconcile the user's account.

func (*FusionAuthClient) IdentityProviderLoginWithContext 

func (c *FusionAuthClient) IdentityProviderLoginWithContext(ctx context.Context, request IdentityProviderLoginRequest) (*LoginResponse, *Errors, error)

IdentityProviderLoginWithContext Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems. 

IdentityProviderLoginRequest request The third-party login request that contains information from the third-party login
providers that FusionAuth uses to reconcile the user's account.

func (*FusionAuthClient) ImportKey 

func (c *FusionAuthClient) ImportKey(keyId string, request KeyRequest) (*KeyResponse, *Errors, error)

ImportKey Import an existing RSA or EC key pair or an HMAC secret. 

string keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
KeyRequest request The request object that contains all the information used to create the key.

func (*FusionAuthClient) ImportKeyWithContext 

func (c *FusionAuthClient) ImportKeyWithContext(ctx context.Context, keyId string, request KeyRequest) (*KeyResponse, *Errors, error)

ImportKeyWithContext Import an existing RSA or EC key pair or an HMAC secret. 

string keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
KeyRequest request The request object that contains all the information used to create the key.

func (*FusionAuthClient) ImportRefreshTokens 

func (c *FusionAuthClient) ImportRefreshTokens(request RefreshTokenImportRequest) (*BaseHTTPResponse, *Errors, error)

ImportRefreshTokens Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter. 

RefreshTokenImportRequest request The request that contains all the information about all the refresh tokens to import.

func (*FusionAuthClient) ImportRefreshTokensWithContext 

func (c *FusionAuthClient) ImportRefreshTokensWithContext(ctx context.Context, request RefreshTokenImportRequest) (*BaseHTTPResponse, *Errors, error)

ImportRefreshTokensWithContext Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter. 

RefreshTokenImportRequest request The request that contains all the information about all the refresh tokens to import.

func (*FusionAuthClient) ImportUsers 

func (c *FusionAuthClient) ImportUsers(request ImportRequest) (*BaseHTTPResponse, *Errors, error)

ImportUsers Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter. 

ImportRequest request The request that contains all the information about all the users to import.

func (*FusionAuthClient) ImportUsersWithContext 

func (c *FusionAuthClient) ImportUsersWithContext(ctx context.Context, request ImportRequest) (*BaseHTTPResponse, *Errors, error)

ImportUsersWithContext Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter. 

ImportRequest request The request that contains all the information about all the users to import.

func (*FusionAuthClient) ImportWebAuthnCredential 

func (c *FusionAuthClient) ImportWebAuthnCredential(request WebAuthnCredentialImportRequest) (*BaseHTTPResponse, *Errors, error)

ImportWebAuthnCredential Import a WebAuthn credential 

WebAuthnCredentialImportRequest request An object containing data necessary for importing the credential

func (*FusionAuthClient) ImportWebAuthnCredentialWithContext 

func (c *FusionAuthClient) ImportWebAuthnCredentialWithContext(ctx context.Context, request WebAuthnCredentialImportRequest) (*BaseHTTPResponse, *Errors, error)

ImportWebAuthnCredentialWithContext Import a WebAuthn credential 

WebAuthnCredentialImportRequest request An object containing data necessary for importing the credential

func (*FusionAuthClient) IssueJWT 

func (c *FusionAuthClient) IssueJWT(applicationId string, encodedJWT string, refreshToken string) (*IssueResponse, *Errors, error)

IssueJWT Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid access token is properly signed and not expired. <p> This API may be used in an SSO configuration to issue new tokens for another application after the user has obtained a valid token from authentication. 

string applicationId The Application Id for which you are requesting a new access token be issued.
string encodedJWT The encoded JWT (access token).
string refreshToken (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.
<p>The target application represented by the applicationId request parameter must have refresh
tokens enabled in order to receive a refresh token in the response.</p>

func (*FusionAuthClient) IssueJWTWithContext 

func (c *FusionAuthClient) IssueJWTWithContext(ctx context.Context, applicationId string, encodedJWT string, refreshToken string) (*IssueResponse, *Errors, error)

IssueJWTWithContext Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid access token is properly signed and not expired. <p> This API may be used in an SSO configuration to issue new tokens for another application after the user has obtained a valid token from authentication. 

string applicationId The Application Id for which you are requesting a new access token be issued.
string encodedJWT The encoded JWT (access token).
string refreshToken (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.
<p>The target application represented by the applicationId request parameter must have refresh
tokens enabled in order to receive a refresh token in the response.</p>

func (*FusionAuthClient) Login 

func (c *FusionAuthClient) Login(request LoginRequest) (*LoginResponse, *Errors, error)

Login Authenticates a user to FusionAuth.

This API optionally requires an API key. See <code>Application.loginConfiguration.requireAuthentication</code>. 

LoginRequest request The login request that contains the user credentials used to log them in.

func (*FusionAuthClient) LoginPing 

func (c *FusionAuthClient) LoginPing(userId string, applicationId string, callerIPAddress string) (*LoginResponse, *Errors, error)

LoginPing Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting. 

string userId The Id of the user that was logged in.
string applicationId The Id of the application that they logged into.
string callerIPAddress (Optional) The IP address of the end-user that is logging in. If a null value is provided
the IP address will be that of the client or last proxy that sent the request.

func (*FusionAuthClient) LoginPingWithContext 

func (c *FusionAuthClient) LoginPingWithContext(ctx context.Context, userId string, applicationId string, callerIPAddress string) (*LoginResponse, *Errors, error)

LoginPingWithContext Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting. 

string userId The Id of the user that was logged in.
string applicationId The Id of the application that they logged into.
string callerIPAddress (Optional) The IP address of the end-user that is logging in. If a null value is provided
the IP address will be that of the client or last proxy that sent the request.

func (*FusionAuthClient) LoginPingWithRequest 

func (c *FusionAuthClient) LoginPingWithRequest(request LoginPingRequest) (*LoginResponse, *Errors, error)

LoginPingWithRequest Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting. 

LoginPingRequest request The login request that contains the user credentials used to log them in.

func (*FusionAuthClient) LoginPingWithRequestWithContext 

func (c *FusionAuthClient) LoginPingWithRequestWithContext(ctx context.Context, request LoginPingRequest) (*LoginResponse, *Errors, error)

LoginPingWithRequestWithContext Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting. 

LoginPingRequest request The login request that contains the user credentials used to log them in.

func (*FusionAuthClient) LoginWithContext 

func (c *FusionAuthClient) LoginWithContext(ctx context.Context, request LoginRequest) (*LoginResponse, *Errors, error)

LoginWithContext Authenticates a user to FusionAuth.

This API optionally requires an API key. See <code>Application.loginConfiguration.requireAuthentication</code>. 

LoginRequest request The login request that contains the user credentials used to log them in.

func (*FusionAuthClient) Logout 

func (c *FusionAuthClient) Logout(global bool, refreshToken string) (*BaseHTTPResponse, error)

Logout The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies. 

bool global When this value is set to true all the refresh tokens issued to the owner of the
provided token will be revoked.
string refreshToken (Optional) The refresh_token as a request parameter instead of coming in via a cookie.
If provided this takes precedence over the cookie.

func (*FusionAuthClient) LogoutWithContext 

func (c *FusionAuthClient) LogoutWithContext(ctx context.Context, global bool, refreshToken string) (*BaseHTTPResponse, error)

LogoutWithContext The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies. 

bool global When this value is set to true all the refresh tokens issued to the owner of the
provided token will be revoked.
string refreshToken (Optional) The refresh_token as a request parameter instead of coming in via a cookie.
If provided this takes precedence over the cookie.

func (*FusionAuthClient) LogoutWithRequest 

func (c *FusionAuthClient) LogoutWithRequest(request LogoutRequest) (*BaseHTTPResponse, error)

LogoutWithRequest The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API takes the refresh token in the JSON body. 

LogoutRequest request The request object that contains all the information used to logout the user.

func (*FusionAuthClient) LogoutWithRequestWithContext 

func (c *FusionAuthClient) LogoutWithRequestWithContext(ctx context.Context, request LogoutRequest) (*BaseHTTPResponse, error)

LogoutWithRequestWithContext The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API takes the refresh token in the JSON body. 

LogoutRequest request The request object that contains all the information used to logout the user.

func (*FusionAuthClient) LookupIdentityProvider 

func (c *FusionAuthClient) LookupIdentityProvider(domain string) (*LookupResponse, error)

LookupIdentityProvider Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed by a registered identity provider. A 404 indicates the domain is not managed. 

string domain The domain or email address to lookup.

func (*FusionAuthClient) LookupIdentityProviderWithContext 

func (c *FusionAuthClient) LookupIdentityProviderWithContext(ctx context.Context, domain string) (*LookupResponse, error)

LookupIdentityProviderWithContext Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed by a registered identity provider. A 404 indicates the domain is not managed. 

string domain The domain or email address to lookup.

func (*FusionAuthClient) ModifyAction 

func (c *FusionAuthClient) ModifyAction(actionId string, request ActionRequest) (*ActionResponse, *Errors, error)

ModifyAction Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action. 

string actionId The Id of the action to modify. This is technically the user action log id.
ActionRequest request The request that contains all the information about the modification.

func (*FusionAuthClient) ModifyActionWithContext 

func (c *FusionAuthClient) ModifyActionWithContext(ctx context.Context, actionId string, request ActionRequest) (*ActionResponse, *Errors, error)

ModifyActionWithContext Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action. 

string actionId The Id of the action to modify. This is technically the user action log id.
ActionRequest request The request that contains all the information about the modification.

func (*FusionAuthClient) PasswordlessLogin 

func (c *FusionAuthClient) PasswordlessLogin(request PasswordlessLoginRequest) (*LoginResponse, *Errors, error)

PasswordlessLogin Complete a login request using a passwordless code 

PasswordlessLoginRequest request The passwordless login request that contains all the information used to complete login.

func (*FusionAuthClient) PasswordlessLoginWithContext 

func (c *FusionAuthClient) PasswordlessLoginWithContext(ctx context.Context, request PasswordlessLoginRequest) (*LoginResponse, *Errors, error)

PasswordlessLoginWithContext Complete a login request using a passwordless code 

PasswordlessLoginRequest request The passwordless login request that contains all the information used to complete login.

func (*FusionAuthClient) PatchAPIKey 

func (c *FusionAuthClient) PatchAPIKey(keyId string, request APIKeyRequest) (*APIKeyResponse, *Errors, error)

PatchAPIKey Updates an authentication API key by given id 

string keyId The Id of the authentication key. If not provided a secure random api key will be generated.
APIKeyRequest request The request object that contains all the information needed to create the APIKey.

func (*FusionAuthClient) PatchAPIKeyWithContext 

func (c *FusionAuthClient) PatchAPIKeyWithContext(ctx context.Context, keyId string, request APIKeyRequest) (*APIKeyResponse, *Errors, error)

PatchAPIKeyWithContext Updates an authentication API key by given id 

string keyId The Id of the authentication key. If not provided a secure random api key will be generated.
APIKeyRequest request The request object that contains all the information needed to create the APIKey.

func (*FusionAuthClient) PatchApplication 

func (c *FusionAuthClient) PatchApplication(applicationId string, request map[string]interface{}) (*ApplicationResponse, *Errors, error)

PatchApplication Updates, via PATCH, the application with the given Id. 

string applicationId The Id of the application to update.
ApplicationRequest request The request that contains just the new application information.

func (*FusionAuthClient) PatchApplicationRole 

func (c *FusionAuthClient) PatchApplicationRole(applicationId string, roleId string, request map[string]interface{}) (*ApplicationResponse, *Errors, error)

PatchApplicationRole Updates, via PATCH, the application role with the given Id for the application. 

string applicationId The Id of the application that the role belongs to.
string roleId The Id of the role to update.
ApplicationRequest request The request that contains just the new role information.

func (*FusionAuthClient) PatchApplicationRoleWithContext 

func (c *FusionAuthClient) PatchApplicationRoleWithContext(ctx context.Context, applicationId string, roleId string, request map[string]interface{}) (*ApplicationResponse, *Errors, error)

PatchApplicationRoleWithContext Updates, via PATCH, the application role with the given Id for the application. 

string applicationId The Id of the application that the role belongs to.
string roleId The Id of the role to update.
ApplicationRequest request The request that contains just the new role information.

func (*FusionAuthClient) PatchApplicationWithContext 

func (c *FusionAuthClient) PatchApplicationWithContext(ctx context.Context, applicationId string, request map[string]interface{}) (*ApplicationResponse, *Errors, error)

PatchApplicationWithContext Updates, via PATCH, the application with the given Id. 

string applicationId The Id of the application to update.
ApplicationRequest request The request that contains just the new application information.

func (*FusionAuthClient) PatchConnector 

func (c *FusionAuthClient) PatchConnector(connectorId string, request map[string]interface{}) (*ConnectorResponse, *Errors, error)

PatchConnector Updates, via PATCH, the connector with the given Id. 

string connectorId The Id of the connector to update.
ConnectorRequest request The request that contains just the new connector information.

func (*FusionAuthClient) PatchConnectorWithContext 

func (c *FusionAuthClient) PatchConnectorWithContext(ctx context.Context, connectorId string, request map[string]interface{}) (*ConnectorResponse, *Errors, error)

PatchConnectorWithContext Updates, via PATCH, the connector with the given Id. 

string connectorId The Id of the connector to update.
ConnectorRequest request The request that contains just the new connector information.

func (*FusionAuthClient) PatchConsent 

func (c *FusionAuthClient) PatchConsent(consentId string, request map[string]interface{}) (*ConsentResponse, *Errors, error)

PatchConsent Updates, via PATCH, the consent with the given Id. 

string consentId The Id of the consent to update.
ConsentRequest request The request that contains just the new consent information.

func (*FusionAuthClient) PatchConsentWithContext 

func (c *FusionAuthClient) PatchConsentWithContext(ctx context.Context, consentId string, request map[string]interface{}) (*ConsentResponse, *Errors, error)

PatchConsentWithContext Updates, via PATCH, the consent with the given Id. 

string consentId The Id of the consent to update.
ConsentRequest request The request that contains just the new consent information.

func (*FusionAuthClient) PatchEmailTemplate 

func (c *FusionAuthClient) PatchEmailTemplate(emailTemplateId string, request map[string]interface{}) (*EmailTemplateResponse, *Errors, error)

PatchEmailTemplate Updates, via PATCH, the email template with the given Id. 

string emailTemplateId The Id of the email template to update.
EmailTemplateRequest request The request that contains just the new email template information.

func (*FusionAuthClient) PatchEmailTemplateWithContext 

func (c *FusionAuthClient) PatchEmailTemplateWithContext(ctx context.Context, emailTemplateId string, request map[string]interface{}) (*EmailTemplateResponse, *Errors, error)

PatchEmailTemplateWithContext Updates, via PATCH, the email template with the given Id. 

string emailTemplateId The Id of the email template to update.
EmailTemplateRequest request The request that contains just the new email template information.

func (*FusionAuthClient) PatchEntity 

func (c *FusionAuthClient) PatchEntity(entityId string, request map[string]interface{}) (*EntityResponse, *Errors, error)

PatchEntity Updates, via PATCH, the Entity with the given Id. 

string entityId The Id of the Entity Type to update.
EntityRequest request The request that contains just the new Entity information.

func (*FusionAuthClient) PatchEntityType 

func (c *FusionAuthClient) PatchEntityType(entityTypeId string, request map[string]interface{}) (*EntityTypeResponse, *Errors, error)

PatchEntityType Updates, via PATCH, the Entity Type with the given Id. 

string entityTypeId The Id of the Entity Type to update.
EntityTypeRequest request The request that contains just the new Entity Type information.

func (*FusionAuthClient) PatchEntityTypePermission 

func (c *FusionAuthClient) PatchEntityTypePermission(entityTypeId string, permissionId string, request map[string]interface{}) (*EntityTypeResponse, *Errors, error)

PatchEntityTypePermission Patches the permission with the given Id for the entity type. 

string entityTypeId The Id of the entityType that the permission belongs to.
string permissionId The Id of the permission to patch.
EntityTypeRequest request The request that contains the new permission information.

func (*FusionAuthClient) PatchEntityTypePermissionWithContext 

func (c *FusionAuthClient) PatchEntityTypePermissionWithContext(ctx context.Context, entityTypeId string, permissionId string, request map[string]interface{}) (*EntityTypeResponse, *Errors, error)

PatchEntityTypePermissionWithContext Patches the permission with the given Id for the entity type. 

string entityTypeId The Id of the entityType that the permission belongs to.
string permissionId The Id of the permission to patch.
EntityTypeRequest request The request that contains the new permission information.

func (*FusionAuthClient) PatchEntityTypeWithContext 

func (c *FusionAuthClient) PatchEntityTypeWithContext(ctx context.Context, entityTypeId string, request map[string]interface{}) (*EntityTypeResponse, *Errors, error)

PatchEntityTypeWithContext Updates, via PATCH, the Entity Type with the given Id. 

string entityTypeId The Id of the Entity Type to update.
EntityTypeRequest request The request that contains just the new Entity Type information.

func (*FusionAuthClient) PatchEntityWithContext 

func (c *FusionAuthClient) PatchEntityWithContext(ctx context.Context, entityId string, request map[string]interface{}) (*EntityResponse, *Errors, error)

PatchEntityWithContext Updates, via PATCH, the Entity with the given Id. 

string entityId The Id of the Entity Type to update.
EntityRequest request The request that contains just the new Entity information.

func (*FusionAuthClient) PatchForm 

func (c *FusionAuthClient) PatchForm(formId string, request map[string]interface{}) (*FormResponse, *Errors, error)

PatchForm Patches the form with the given Id. 

string formId The Id of the form to patch.
FormRequest request The request object that contains the new form information.

func (*FusionAuthClient) PatchFormField 

func (c *FusionAuthClient) PatchFormField(fieldId string, request map[string]interface{}) (*FormFieldResponse, *Errors, error)

PatchFormField Patches the form field with the given Id. 

string fieldId The Id of the form field to patch.
FormFieldRequest request The request object that contains the new form field information.

func (*FusionAuthClient) PatchFormFieldWithContext 

func (c *FusionAuthClient) PatchFormFieldWithContext(ctx context.Context, fieldId string, request map[string]interface{}) (*FormFieldResponse, *Errors, error)

PatchFormFieldWithContext Patches the form field with the given Id. 

string fieldId The Id of the form field to patch.
FormFieldRequest request The request object that contains the new form field information.

func (*FusionAuthClient) PatchFormWithContext 

func (c *FusionAuthClient) PatchFormWithContext(ctx context.Context, formId string, request map[string]interface{}) (*FormResponse, *Errors, error)

PatchFormWithContext Patches the form with the given Id. 

string formId The Id of the form to patch.
FormRequest request The request object that contains the new form information.

func (*FusionAuthClient) PatchGroup 

func (c *FusionAuthClient) PatchGroup(groupId string, request map[string]interface{}) (*GroupResponse, *Errors, error)

PatchGroup Updates, via PATCH, the group with the given Id. 

string groupId The Id of the group to update.
GroupRequest request The request that contains just the new group information.

func (*FusionAuthClient) PatchGroupWithContext 

func (c *FusionAuthClient) PatchGroupWithContext(ctx context.Context, groupId string, request map[string]interface{}) (*GroupResponse, *Errors, error)

PatchGroupWithContext Updates, via PATCH, the group with the given Id. 

string groupId The Id of the group to update.
GroupRequest request The request that contains just the new group information.

func (*FusionAuthClient) PatchIPAccessControlList 

func (c *FusionAuthClient) PatchIPAccessControlList(accessControlListId string, request map[string]interface{}) (*IPAccessControlListResponse, *Errors, error)

PatchIPAccessControlList Update the IP Access Control List with the given Id. 

string accessControlListId The Id of the IP Access Control List to patch.
IPAccessControlListRequest request The request that contains the new IP Access Control List information.

func (*FusionAuthClient) PatchIPAccessControlListWithContext 

func (c *FusionAuthClient) PatchIPAccessControlListWithContext(ctx context.Context, accessControlListId string, request map[string]interface{}) (*IPAccessControlListResponse, *Errors, error)

PatchIPAccessControlListWithContext Update the IP Access Control List with the given Id. 

string accessControlListId The Id of the IP Access Control List to patch.
IPAccessControlListRequest request The request that contains the new IP Access Control List information.

func (*FusionAuthClient) PatchIdentityProvider 

func (c *FusionAuthClient) PatchIdentityProvider(identityProviderId string, request map[string]interface{}) (*IdentityProviderResponse, *Errors, error)

PatchIdentityProvider Updates, via PATCH, the identity provider with the given Id. 

string identityProviderId The Id of the identity provider to update.
IdentityProviderRequest request The request object that contains just the updated identity provider information.

func (*FusionAuthClient) PatchIdentityProviderWithContext 

func (c *FusionAuthClient) PatchIdentityProviderWithContext(ctx context.Context, identityProviderId string, request map[string]interface{}) (*IdentityProviderResponse, *Errors, error)

PatchIdentityProviderWithContext Updates, via PATCH, the identity provider with the given Id. 

string identityProviderId The Id of the identity provider to update.
IdentityProviderRequest request The request object that contains just the updated identity provider information.

func (*FusionAuthClient) PatchIntegrations 

func (c *FusionAuthClient) PatchIntegrations(request map[string]interface{}) (*IntegrationResponse, *Errors, error)

PatchIntegrations Updates, via PATCH, the available integrations. 

IntegrationRequest request The request that contains just the new integration information.

func (*FusionAuthClient) PatchIntegrationsWithContext 

func (c *FusionAuthClient) PatchIntegrationsWithContext(ctx context.Context, request map[string]interface{}) (*IntegrationResponse, *Errors, error)

PatchIntegrationsWithContext Updates, via PATCH, the available integrations. 

IntegrationRequest request The request that contains just the new integration information.

func (*FusionAuthClient) PatchLambda 

func (c *FusionAuthClient) PatchLambda(lambdaId string, request map[string]interface{}) (*LambdaResponse, *Errors, error)

PatchLambda Updates, via PATCH, the lambda with the given Id. 

string lambdaId The Id of the lambda to update.
LambdaRequest request The request that contains just the new lambda information.

func (*FusionAuthClient) PatchLambdaWithContext 

func (c *FusionAuthClient) PatchLambdaWithContext(ctx context.Context, lambdaId string, request map[string]interface{}) (*LambdaResponse, *Errors, error)

PatchLambdaWithContext Updates, via PATCH, the lambda with the given Id. 

string lambdaId The Id of the lambda to update.
LambdaRequest request The request that contains just the new lambda information.

func (*FusionAuthClient) PatchMessageTemplate 

func (c *FusionAuthClient) PatchMessageTemplate(messageTemplateId string, request map[string]interface{}) (*MessageTemplateResponse, *Errors, error)

PatchMessageTemplate Updates, via PATCH, the message template with the given Id. 

string messageTemplateId The Id of the message template to update.
MessageTemplateRequest request The request that contains just the new message template information.

func (*FusionAuthClient) PatchMessageTemplateWithContext 

func (c *FusionAuthClient) PatchMessageTemplateWithContext(ctx context.Context, messageTemplateId string, request map[string]interface{}) (*MessageTemplateResponse, *Errors, error)

PatchMessageTemplateWithContext Updates, via PATCH, the message template with the given Id. 

string messageTemplateId The Id of the message template to update.
MessageTemplateRequest request The request that contains just the new message template information.

func (*FusionAuthClient) PatchMessenger 

func (c *FusionAuthClient) PatchMessenger(messengerId string, request map[string]interface{}) (*MessengerResponse, *Errors, error)

PatchMessenger Updates, via PATCH, the messenger with the given Id. 

string messengerId The Id of the messenger to update.
MessengerRequest request The request that contains just the new messenger information.

func (*FusionAuthClient) PatchMessengerWithContext 

func (c *FusionAuthClient) PatchMessengerWithContext(ctx context.Context, messengerId string, request map[string]interface{}) (*MessengerResponse, *Errors, error)

PatchMessengerWithContext Updates, via PATCH, the messenger with the given Id. 

string messengerId The Id of the messenger to update.
MessengerRequest request The request that contains just the new messenger information.

func (*FusionAuthClient) PatchOAuthScope 

func (c *FusionAuthClient) PatchOAuthScope(applicationId string, scopeId string, request map[string]interface{}) (*ApplicationOAuthScopeResponse, *Errors, error)

PatchOAuthScope Updates, via PATCH, the custom OAuth scope with the given Id for the application. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to update.
ApplicationOAuthScopeRequest request The request that contains just the new OAuth scope information.

func (*FusionAuthClient) PatchOAuthScopeWithContext 

func (c *FusionAuthClient) PatchOAuthScopeWithContext(ctx context.Context, applicationId string, scopeId string, request map[string]interface{}) (*ApplicationOAuthScopeResponse, *Errors, error)

PatchOAuthScopeWithContext Updates, via PATCH, the custom OAuth scope with the given Id for the application. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to update.
ApplicationOAuthScopeRequest request The request that contains just the new OAuth scope information.

func (*FusionAuthClient) PatchRegistration 

func (c *FusionAuthClient) PatchRegistration(userId string, request map[string]interface{}) (*RegistrationResponse, *Errors, error)

PatchRegistration Updates, via PATCH, the registration for the user with the given Id and the application defined in the request. 

string userId The Id of the user whose registration is going to be updated.
RegistrationRequest request The request that contains just the new registration information.

func (*FusionAuthClient) PatchRegistrationWithContext 

func (c *FusionAuthClient) PatchRegistrationWithContext(ctx context.Context, userId string, request map[string]interface{}) (*RegistrationResponse, *Errors, error)

PatchRegistrationWithContext Updates, via PATCH, the registration for the user with the given Id and the application defined in the request. 

string userId The Id of the user whose registration is going to be updated.
RegistrationRequest request The request that contains just the new registration information.

func (*FusionAuthClient) PatchSystemConfiguration 

func (c *FusionAuthClient) PatchSystemConfiguration(request map[string]interface{}) (*SystemConfigurationResponse, *Errors, error)

PatchSystemConfiguration Updates, via PATCH, the system configuration. 

SystemConfigurationRequest request The request that contains just the new system configuration information.

func (*FusionAuthClient) PatchSystemConfigurationWithContext 

func (c *FusionAuthClient) PatchSystemConfigurationWithContext(ctx context.Context, request map[string]interface{}) (*SystemConfigurationResponse, *Errors, error)

PatchSystemConfigurationWithContext Updates, via PATCH, the system configuration. 

SystemConfigurationRequest request The request that contains just the new system configuration information.

func (*FusionAuthClient) PatchTenant 

func (c *FusionAuthClient) PatchTenant(tenantId string, request map[string]interface{}) (*TenantResponse, *Errors, error)

PatchTenant Updates, via PATCH, the tenant with the given Id. 

string tenantId The Id of the tenant to update.
TenantRequest request The request that contains just the new tenant information.

func (*FusionAuthClient) PatchTenantWithContext 

func (c *FusionAuthClient) PatchTenantWithContext(ctx context.Context, tenantId string, request map[string]interface{}) (*TenantResponse, *Errors, error)

PatchTenantWithContext Updates, via PATCH, the tenant with the given Id. 

string tenantId The Id of the tenant to update.
TenantRequest request The request that contains just the new tenant information.

func (*FusionAuthClient) PatchTheme 

func (c *FusionAuthClient) PatchTheme(themeId string, request map[string]interface{}) (*ThemeResponse, *Errors, error)

PatchTheme Updates, via PATCH, the theme with the given Id. 

string themeId The Id of the theme to update.
ThemeRequest request The request that contains just the new theme information.

func (*FusionAuthClient) PatchThemeWithContext 

func (c *FusionAuthClient) PatchThemeWithContext(ctx context.Context, themeId string, request map[string]interface{}) (*ThemeResponse, *Errors, error)

PatchThemeWithContext Updates, via PATCH, the theme with the given Id. 

string themeId The Id of the theme to update.
ThemeRequest request The request that contains just the new theme information.

func (*FusionAuthClient) PatchUser 

func (c *FusionAuthClient) PatchUser(userId string, request map[string]interface{}) (*UserResponse, *Errors, error)

PatchUser Updates, via PATCH, the user with the given Id. 

string userId The Id of the user to update.
UserRequest request The request that contains just the new user information.

func (*FusionAuthClient) PatchUserAction 

func (c *FusionAuthClient) PatchUserAction(userActionId string, request map[string]interface{}) (*UserActionResponse, *Errors, error)

PatchUserAction Updates, via PATCH, the user action with the given Id. 

string userActionId The Id of the user action to update.
UserActionRequest request The request that contains just the new user action information.

func (*FusionAuthClient) PatchUserActionReason 

func (c *FusionAuthClient) PatchUserActionReason(userActionReasonId string, request map[string]interface{}) (*UserActionReasonResponse, *Errors, error)

PatchUserActionReason Updates, via PATCH, the user action reason with the given Id. 

string userActionReasonId The Id of the user action reason to update.
UserActionReasonRequest request The request that contains just the new user action reason information.

func (*FusionAuthClient) PatchUserActionReasonWithContext 

func (c *FusionAuthClient) PatchUserActionReasonWithContext(ctx context.Context, userActionReasonId string, request map[string]interface{}) (*UserActionReasonResponse, *Errors, error)

PatchUserActionReasonWithContext Updates, via PATCH, the user action reason with the given Id. 

string userActionReasonId The Id of the user action reason to update.
UserActionReasonRequest request The request that contains just the new user action reason information.

func (*FusionAuthClient) PatchUserActionWithContext 

func (c *FusionAuthClient) PatchUserActionWithContext(ctx context.Context, userActionId string, request map[string]interface{}) (*UserActionResponse, *Errors, error)

PatchUserActionWithContext Updates, via PATCH, the user action with the given Id. 

string userActionId The Id of the user action to update.
UserActionRequest request The request that contains just the new user action information.

func (*FusionAuthClient) PatchUserConsent 

func (c *FusionAuthClient) PatchUserConsent(userConsentId string, request map[string]interface{}) (*UserConsentResponse, *Errors, error)

PatchUserConsent Updates, via PATCH, a single User consent by Id. 

string userConsentId The User Consent Id
UserConsentRequest request The request that contains just the new user consent information.

func (*FusionAuthClient) PatchUserConsentWithContext 

func (c *FusionAuthClient) PatchUserConsentWithContext(ctx context.Context, userConsentId string, request map[string]interface{}) (*UserConsentResponse, *Errors, error)

PatchUserConsentWithContext Updates, via PATCH, a single User consent by Id. 

string userConsentId The User Consent Id
UserConsentRequest request The request that contains just the new user consent information.

func (*FusionAuthClient) PatchUserWithContext 

func (c *FusionAuthClient) PatchUserWithContext(ctx context.Context, userId string, request map[string]interface{}) (*UserResponse, *Errors, error)

PatchUserWithContext Updates, via PATCH, the user with the given Id. 

string userId The Id of the user to update.
UserRequest request The request that contains just the new user information.

func (*FusionAuthClient) PatchWebhook 

func (c *FusionAuthClient) PatchWebhook(webhookId string, request map[string]interface{}) (*WebhookResponse, *Errors, error)

PatchWebhook Patches the webhook with the given Id. 

string webhookId The Id of the webhook to update.
WebhookRequest request The request that contains the new webhook information.

func (*FusionAuthClient) PatchWebhookWithContext 

func (c *FusionAuthClient) PatchWebhookWithContext(ctx context.Context, webhookId string, request map[string]interface{}) (*WebhookResponse, *Errors, error)

PatchWebhookWithContext Patches the webhook with the given Id. 

string webhookId The Id of the webhook to update.
WebhookRequest request The request that contains the new webhook information.

func (*FusionAuthClient) ReactivateApplication 

func (c *FusionAuthClient) ReactivateApplication(applicationId string) (*ApplicationResponse, *Errors, error)

ReactivateApplication Reactivates the application with the given Id. 

string applicationId The Id of the application to reactivate.

func (*FusionAuthClient) ReactivateApplicationWithContext 

func (c *FusionAuthClient) ReactivateApplicationWithContext(ctx context.Context, applicationId string) (*ApplicationResponse, *Errors, error)

ReactivateApplicationWithContext Reactivates the application with the given Id. 

string applicationId The Id of the application to reactivate.

func (*FusionAuthClient) ReactivateUser 

func (c *FusionAuthClient) ReactivateUser(userId string) (*UserResponse, *Errors, error)

ReactivateUser Reactivates the user with the given Id. 

string userId The Id of the user to reactivate.

func (*FusionAuthClient) ReactivateUserAction 

func (c *FusionAuthClient) ReactivateUserAction(userActionId string) (*UserActionResponse, *Errors, error)

ReactivateUserAction Reactivates the user action with the given Id. 

string userActionId The Id of the user action to reactivate.

func (*FusionAuthClient) ReactivateUserActionWithContext 

func (c *FusionAuthClient) ReactivateUserActionWithContext(ctx context.Context, userActionId string) (*UserActionResponse, *Errors, error)

ReactivateUserActionWithContext Reactivates the user action with the given Id. 

string userActionId The Id of the user action to reactivate.

func (*FusionAuthClient) ReactivateUserWithContext 

func (c *FusionAuthClient) ReactivateUserWithContext(ctx context.Context, userId string) (*UserResponse, *Errors, error)

ReactivateUserWithContext Reactivates the user with the given Id. 

string userId The Id of the user to reactivate.

func (*FusionAuthClient) ReconcileJWT 

func (c *FusionAuthClient) ReconcileJWT(request IdentityProviderLoginRequest) (*LoginResponse, *Errors, error)

ReconcileJWT Reconcile a User to FusionAuth using JWT issued from another Identity Provider. 

IdentityProviderLoginRequest request The reconcile request that contains the data to reconcile the User.

func (*FusionAuthClient) ReconcileJWTWithContext 

func (c *FusionAuthClient) ReconcileJWTWithContext(ctx context.Context, request IdentityProviderLoginRequest) (*LoginResponse, *Errors, error)

ReconcileJWTWithContext Reconcile a User to FusionAuth using JWT issued from another Identity Provider. 

IdentityProviderLoginRequest request The reconcile request that contains the data to reconcile the User.

func (*FusionAuthClient) RefreshEntitySearchIndex 

func (c *FusionAuthClient) RefreshEntitySearchIndex() (*BaseHTTPResponse, error)

RefreshEntitySearchIndex Request a refresh of the Entity search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a Entity Create etc, you may wish to request a refresh to 

ensure the index immediately current before making a query request to the search index.

func (*FusionAuthClient) RefreshEntitySearchIndexWithContext 

func (c *FusionAuthClient) RefreshEntitySearchIndexWithContext(ctx context.Context) (*BaseHTTPResponse, error)

RefreshEntitySearchIndexWithContext Request a refresh of the Entity search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a Entity Create etc, you may wish to request a refresh to 

ensure the index immediately current before making a query request to the search index.

func (*FusionAuthClient) RefreshUserSearchIndex 

func (c *FusionAuthClient) RefreshUserSearchIndex() (*BaseHTTPResponse, error)

RefreshUserSearchIndex Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to 

ensure the index immediately current before making a query request to the search index.

func (*FusionAuthClient) RefreshUserSearchIndexWithContext 

func (c *FusionAuthClient) RefreshUserSearchIndexWithContext(ctx context.Context) (*BaseHTTPResponse, error)

RefreshUserSearchIndexWithContext Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to 

ensure the index immediately current before making a query request to the search index.

func (*FusionAuthClient) RegenerateReactorKeys 

func (c *FusionAuthClient) RegenerateReactorKeys() (*BaseHTTPResponse, error)

RegenerateReactorKeys Regenerates any keys that are used by the FusionAuth Reactor.

func (*FusionAuthClient) RegenerateReactorKeysWithContext 

func (c *FusionAuthClient) RegenerateReactorKeysWithContext(ctx context.Context) (*BaseHTTPResponse, error)

RegenerateReactorKeysWithContext Regenerates any keys that are used by the FusionAuth Reactor.

func (*FusionAuthClient) Register 

func (c *FusionAuthClient) Register(userId string, request RegistrationRequest) (*RegistrationResponse, *Errors, error)

Register Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user Id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User. 

string userId (Optional) The Id of the user being registered for the application and optionally created.
RegistrationRequest request The request that optionally contains the User and must contain the UserRegistration.

func (*FusionAuthClient) RegisterWithContext 

func (c *FusionAuthClient) RegisterWithContext(ctx context.Context, userId string, request RegistrationRequest) (*RegistrationResponse, *Errors, error)

RegisterWithContext Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user Id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User. 

string userId (Optional) The Id of the user being registered for the application and optionally created.
RegistrationRequest request The request that optionally contains the User and must contain the UserRegistration.

func (*FusionAuthClient) Reindex 

func (c *FusionAuthClient) Reindex(request ReindexRequest) (*BaseHTTPResponse, *Errors, error)

Reindex Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index.

You have been warned. 

ReindexRequest request The request that contains the index name.

func (*FusionAuthClient) ReindexWithContext 

func (c *FusionAuthClient) ReindexWithContext(ctx context.Context, request ReindexRequest) (*BaseHTTPResponse, *Errors, error)

ReindexWithContext Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index.

You have been warned. 

ReindexRequest request The request that contains the index name.

func (*FusionAuthClient) RemoveUserFromFamily 

func (c *FusionAuthClient) RemoveUserFromFamily(familyId string, userId string) (*BaseHTTPResponse, *Errors, error)

RemoveUserFromFamily Removes a user from the family with the given id. 

string familyId The Id of the family to remove the user from.
string userId The Id of the user to remove from the family.

func (*FusionAuthClient) RemoveUserFromFamilyWithContext 

func (c *FusionAuthClient) RemoveUserFromFamilyWithContext(ctx context.Context, familyId string, userId string) (*BaseHTTPResponse, *Errors, error)

RemoveUserFromFamilyWithContext Removes a user from the family with the given id. 

string familyId The Id of the family to remove the user from.
string userId The Id of the user to remove from the family.

func (*FusionAuthClient) ResendEmailVerification 

func (c *FusionAuthClient) ResendEmailVerification(email string) (*VerifyEmailResponse, *Errors, error)

ResendEmailVerification Re-sends the verification email to the user. 

string email The email address of the user that needs a new verification email.

func (*FusionAuthClient) ResendEmailVerificationWithApplicationTemplate 

func (c *FusionAuthClient) ResendEmailVerificationWithApplicationTemplate(applicationId string, email string) (*VerifyEmailResponse, *Errors, error)

ResendEmailVerificationWithApplicationTemplate Re-sends the verification email to the user. If the Application has configured a specific email template this will be used instead of the tenant configuration. 

string applicationId The unique Application Id to used to resolve an application specific email template.
string email The email address of the user that needs a new verification email.

func (*FusionAuthClient) ResendEmailVerificationWithApplicationTemplateWithContext 

func (c *FusionAuthClient) ResendEmailVerificationWithApplicationTemplateWithContext(ctx context.Context, applicationId string, email string) (*VerifyEmailResponse, *Errors, error)

ResendEmailVerificationWithApplicationTemplateWithContext Re-sends the verification email to the user. If the Application has configured a specific email template this will be used instead of the tenant configuration. 

string applicationId The unique Application Id to used to resolve an application specific email template.
string email The email address of the user that needs a new verification email.

func (*FusionAuthClient) ResendEmailVerificationWithContext 

func (c *FusionAuthClient) ResendEmailVerificationWithContext(ctx context.Context, email string) (*VerifyEmailResponse, *Errors, error)

ResendEmailVerificationWithContext Re-sends the verification email to the user. 

string email The email address of the user that needs a new verification email.

func (*FusionAuthClient) ResendRegistrationVerification 

func (c *FusionAuthClient) ResendRegistrationVerification(email string, applicationId string) (*VerifyRegistrationResponse, *Errors, error)

ResendRegistrationVerification Re-sends the application registration verification email to the user. 

string email The email address of the user that needs a new verification email.
string applicationId The Id of the application to be verified.

func (*FusionAuthClient) ResendRegistrationVerificationWithContext 

func (c *FusionAuthClient) ResendRegistrationVerificationWithContext(ctx context.Context, email string, applicationId string) (*VerifyRegistrationResponse, *Errors, error)

ResendRegistrationVerificationWithContext Re-sends the application registration verification email to the user. 

string email The email address of the user that needs a new verification email.
string applicationId The Id of the application to be verified.

func (*FusionAuthClient) RetrieveAPIKey 

func (c *FusionAuthClient) RetrieveAPIKey(keyId string) (*APIKeyResponse, *Errors, error)

RetrieveAPIKey Retrieves an authentication API key for the given id 

string keyId The Id of the API key to retrieve.

func (*FusionAuthClient) RetrieveAPIKeyWithContext 

func (c *FusionAuthClient) RetrieveAPIKeyWithContext(ctx context.Context, keyId string) (*APIKeyResponse, *Errors, error)

RetrieveAPIKeyWithContext Retrieves an authentication API key for the given id 

string keyId The Id of the API key to retrieve.

func (*FusionAuthClient) RetrieveAction 

func (c *FusionAuthClient) RetrieveAction(actionId string) (*ActionResponse, *Errors, error)

RetrieveAction Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id. 

string actionId The Id of the action to retrieve.

func (*FusionAuthClient) RetrieveActionWithContext 

func (c *FusionAuthClient) RetrieveActionWithContext(ctx context.Context, actionId string) (*ActionResponse, *Errors, error)

RetrieveActionWithContext Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id. 

string actionId The Id of the action to retrieve.

func (*FusionAuthClient) RetrieveActions 

func (c *FusionAuthClient) RetrieveActions(userId string) (*ActionResponse, *Errors, error)

RetrieveActions Retrieves all the actions for the user with the given Id. This will return all time based actions that are active, and inactive as well as non-time based actions. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveActionsPreventingLogin 

func (c *FusionAuthClient) RetrieveActionsPreventingLogin(userId string) (*ActionResponse, *Errors, error)

RetrieveActionsPreventingLogin Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveActionsPreventingLoginWithContext 

func (c *FusionAuthClient) RetrieveActionsPreventingLoginWithContext(ctx context.Context, userId string) (*ActionResponse, *Errors, error)

RetrieveActionsPreventingLoginWithContext Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveActionsWithContext 

func (c *FusionAuthClient) RetrieveActionsWithContext(ctx context.Context, userId string) (*ActionResponse, *Errors, error)

RetrieveActionsWithContext Retrieves all the actions for the user with the given Id. This will return all time based actions that are active, and inactive as well as non-time based actions. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveActiveActions 

func (c *FusionAuthClient) RetrieveActiveActions(userId string) (*ActionResponse, *Errors, error)

RetrieveActiveActions Retrieves all the actions for the user with the given Id that are currently active. An active action means one that is time based and has not been canceled, and has not ended. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveActiveActionsWithContext 

func (c *FusionAuthClient) RetrieveActiveActionsWithContext(ctx context.Context, userId string) (*ActionResponse, *Errors, error)

RetrieveActiveActionsWithContext Retrieves all the actions for the user with the given Id that are currently active. An active action means one that is time based and has not been canceled, and has not ended. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveApplication 

func (c *FusionAuthClient) RetrieveApplication(applicationId string) (*ApplicationResponse, error)

RetrieveApplication Retrieves the application for the given Id or all the applications if the Id is null. 

string applicationId (Optional) The application id.

func (*FusionAuthClient) RetrieveApplicationWithContext 

func (c *FusionAuthClient) RetrieveApplicationWithContext(ctx context.Context, applicationId string) (*ApplicationResponse, error)

RetrieveApplicationWithContext Retrieves the application for the given Id or all the applications if the Id is null. 

string applicationId (Optional) The application id.

func (*FusionAuthClient) RetrieveApplications 

func (c *FusionAuthClient) RetrieveApplications() (*ApplicationResponse, error)

RetrieveApplications Retrieves all the applications.

func (*FusionAuthClient) RetrieveApplicationsWithContext 

func (c *FusionAuthClient) RetrieveApplicationsWithContext(ctx context.Context) (*ApplicationResponse, error)

RetrieveApplicationsWithContext Retrieves all the applications.

func (*FusionAuthClient) RetrieveAuditLog 

func (c *FusionAuthClient) RetrieveAuditLog(auditLogId int) (*AuditLogResponse, *Errors, error)

RetrieveAuditLog Retrieves a single audit log for the given Id. 

int auditLogId The Id of the audit log to retrieve.

func (*FusionAuthClient) RetrieveAuditLogWithContext 

func (c *FusionAuthClient) RetrieveAuditLogWithContext(ctx context.Context, auditLogId int) (*AuditLogResponse, *Errors, error)

RetrieveAuditLogWithContext Retrieves a single audit log for the given Id. 

int auditLogId The Id of the audit log to retrieve.

func (*FusionAuthClient) RetrieveConnector 

func (c *FusionAuthClient) RetrieveConnector(connectorId string) (*ConnectorResponse, error)

RetrieveConnector Retrieves the connector with the given Id. 

string connectorId The Id of the connector.

func (*FusionAuthClient) RetrieveConnectorWithContext 

func (c *FusionAuthClient) RetrieveConnectorWithContext(ctx context.Context, connectorId string) (*ConnectorResponse, error)

RetrieveConnectorWithContext Retrieves the connector with the given Id. 

string connectorId The Id of the connector.

func (*FusionAuthClient) RetrieveConnectors 

func (c *FusionAuthClient) RetrieveConnectors() (*ConnectorResponse, error)

RetrieveConnectors Retrieves all the connectors.

func (*FusionAuthClient) RetrieveConnectorsWithContext 

func (c *FusionAuthClient) RetrieveConnectorsWithContext(ctx context.Context) (*ConnectorResponse, error)

RetrieveConnectorsWithContext Retrieves all the connectors.

func (*FusionAuthClient) RetrieveConsent 

func (c *FusionAuthClient) RetrieveConsent(consentId string) (*ConsentResponse, error)

RetrieveConsent Retrieves the Consent for the given Id. 

string consentId The Id of the consent.

func (*FusionAuthClient) RetrieveConsentWithContext 

func (c *FusionAuthClient) RetrieveConsentWithContext(ctx context.Context, consentId string) (*ConsentResponse, error)

RetrieveConsentWithContext Retrieves the Consent for the given Id. 

string consentId The Id of the consent.

func (*FusionAuthClient) RetrieveConsents 

func (c *FusionAuthClient) RetrieveConsents() (*ConsentResponse, error)

RetrieveConsents Retrieves all the consent.

func (*FusionAuthClient) RetrieveConsentsWithContext 

func (c *FusionAuthClient) RetrieveConsentsWithContext(ctx context.Context) (*ConsentResponse, error)

RetrieveConsentsWithContext Retrieves all the consent.

func (*FusionAuthClient) RetrieveDailyActiveReport 

func (c *FusionAuthClient) RetrieveDailyActiveReport(applicationId string, start int64, end int64) (*DailyActiveUserReportResponse, *Errors, error)

RetrieveDailyActiveReport Retrieves the daily active user report between the two instants. If you specify an application id, it will only return the daily active counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveDailyActiveReportWithContext 

func (c *FusionAuthClient) RetrieveDailyActiveReportWithContext(ctx context.Context, applicationId string, start int64, end int64) (*DailyActiveUserReportResponse, *Errors, error)

RetrieveDailyActiveReportWithContext Retrieves the daily active user report between the two instants. If you specify an application id, it will only return the daily active counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveEmailTemplate 

func (c *FusionAuthClient) RetrieveEmailTemplate(emailTemplateId string) (*EmailTemplateResponse, error)

RetrieveEmailTemplate Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates. 

string emailTemplateId (Optional) The Id of the email template.

func (*FusionAuthClient) RetrieveEmailTemplatePreview 

func (c *FusionAuthClient) RetrieveEmailTemplatePreview(request PreviewRequest) (*PreviewResponse, *Errors, error)

RetrieveEmailTemplatePreview Creates a preview of the email template provided in the request. This allows you to preview an email template that hasn't been saved to the database yet. The entire email template does not need to be provided on the request. This will create the preview based on whatever is given. 

PreviewRequest request The request that contains the email template and optionally a locale to render it in.

func (*FusionAuthClient) RetrieveEmailTemplatePreviewWithContext 

func (c *FusionAuthClient) RetrieveEmailTemplatePreviewWithContext(ctx context.Context, request PreviewRequest) (*PreviewResponse, *Errors, error)

RetrieveEmailTemplatePreviewWithContext Creates a preview of the email template provided in the request. This allows you to preview an email template that hasn't been saved to the database yet. The entire email template does not need to be provided on the request. This will create the preview based on whatever is given. 

PreviewRequest request The request that contains the email template and optionally a locale to render it in.

func (*FusionAuthClient) RetrieveEmailTemplateWithContext 

func (c *FusionAuthClient) RetrieveEmailTemplateWithContext(ctx context.Context, emailTemplateId string) (*EmailTemplateResponse, error)

RetrieveEmailTemplateWithContext Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates. 

string emailTemplateId (Optional) The Id of the email template.

func (*FusionAuthClient) RetrieveEmailTemplates 

func (c *FusionAuthClient) RetrieveEmailTemplates() (*EmailTemplateResponse, error)

RetrieveEmailTemplates Retrieves all the email templates.

func (*FusionAuthClient) RetrieveEmailTemplatesWithContext 

func (c *FusionAuthClient) RetrieveEmailTemplatesWithContext(ctx context.Context) (*EmailTemplateResponse, error)

RetrieveEmailTemplatesWithContext Retrieves all the email templates.

func (*FusionAuthClient) RetrieveEntity 

func (c *FusionAuthClient) RetrieveEntity(entityId string) (*EntityResponse, *Errors, error)

RetrieveEntity Retrieves the Entity for the given Id. 

string entityId The Id of the Entity.

func (*FusionAuthClient) RetrieveEntityGrant 

func (c *FusionAuthClient) RetrieveEntityGrant(entityId string, recipientEntityId string, userId string) (*EntityGrantResponse, *Errors, error)

RetrieveEntityGrant Retrieves an Entity Grant for the given Entity and User/Entity. 

string entityId The Id of the Entity.
string recipientEntityId (Optional) The Id of the Entity that the Entity Grant is for.
string userId (Optional) The Id of the User that the Entity Grant is for.

func (*FusionAuthClient) RetrieveEntityGrantWithContext 

func (c *FusionAuthClient) RetrieveEntityGrantWithContext(ctx context.Context, entityId string, recipientEntityId string, userId string) (*EntityGrantResponse, *Errors, error)

RetrieveEntityGrantWithContext Retrieves an Entity Grant for the given Entity and User/Entity. 

string entityId The Id of the Entity.
string recipientEntityId (Optional) The Id of the Entity that the Entity Grant is for.
string userId (Optional) The Id of the User that the Entity Grant is for.

func (*FusionAuthClient) RetrieveEntityType 

func (c *FusionAuthClient) RetrieveEntityType(entityTypeId string) (*EntityTypeResponse, *Errors, error)

RetrieveEntityType Retrieves the Entity Type for the given Id. 

string entityTypeId The Id of the Entity Type.

func (*FusionAuthClient) RetrieveEntityTypeWithContext 

func (c *FusionAuthClient) RetrieveEntityTypeWithContext(ctx context.Context, entityTypeId string) (*EntityTypeResponse, *Errors, error)

RetrieveEntityTypeWithContext Retrieves the Entity Type for the given Id. 

string entityTypeId The Id of the Entity Type.

func (*FusionAuthClient) RetrieveEntityTypes 

func (c *FusionAuthClient) RetrieveEntityTypes() (*EntityTypeResponse, *Errors, error)

RetrieveEntityTypes Retrieves all the Entity Types.

func (*FusionAuthClient) RetrieveEntityTypesWithContext 

func (c *FusionAuthClient) RetrieveEntityTypesWithContext(ctx context.Context) (*EntityTypeResponse, *Errors, error)

RetrieveEntityTypesWithContext Retrieves all the Entity Types.

func (*FusionAuthClient) RetrieveEntityWithContext 

func (c *FusionAuthClient) RetrieveEntityWithContext(ctx context.Context, entityId string) (*EntityResponse, *Errors, error)

RetrieveEntityWithContext Retrieves the Entity for the given Id. 

string entityId The Id of the Entity.

func (*FusionAuthClient) RetrieveEventLog 

func (c *FusionAuthClient) RetrieveEventLog(eventLogId int) (*EventLogResponse, *Errors, error)

RetrieveEventLog Retrieves a single event log for the given Id. 

int eventLogId The Id of the event log to retrieve.

func (*FusionAuthClient) RetrieveEventLogWithContext 

func (c *FusionAuthClient) RetrieveEventLogWithContext(ctx context.Context, eventLogId int) (*EventLogResponse, *Errors, error)

RetrieveEventLogWithContext Retrieves a single event log for the given Id. 

int eventLogId The Id of the event log to retrieve.

func (*FusionAuthClient) RetrieveFamilies 

func (c *FusionAuthClient) RetrieveFamilies(userId string) (*FamilyResponse, error)

RetrieveFamilies Retrieves all the families that a user belongs to. 

string userId The User's id

func (*FusionAuthClient) RetrieveFamiliesWithContext 

func (c *FusionAuthClient) RetrieveFamiliesWithContext(ctx context.Context, userId string) (*FamilyResponse, error)

RetrieveFamiliesWithContext Retrieves all the families that a user belongs to. 

string userId The User's id

func (*FusionAuthClient) RetrieveFamilyMembersByFamilyId 

func (c *FusionAuthClient) RetrieveFamilyMembersByFamilyId(familyId string) (*FamilyResponse, error)

RetrieveFamilyMembersByFamilyId Retrieves all the members of a family by the unique Family Id. 

string familyId The unique Id of the Family.

func (*FusionAuthClient) RetrieveFamilyMembersByFamilyIdWithContext 

func (c *FusionAuthClient) RetrieveFamilyMembersByFamilyIdWithContext(ctx context.Context, familyId string) (*FamilyResponse, error)

RetrieveFamilyMembersByFamilyIdWithContext Retrieves all the members of a family by the unique Family Id. 

string familyId The unique Id of the Family.

func (*FusionAuthClient) RetrieveForm 

func (c *FusionAuthClient) RetrieveForm(formId string) (*FormResponse, error)

RetrieveForm Retrieves the form with the given Id. 

string formId The Id of the form.

func (*FusionAuthClient) RetrieveFormField 

func (c *FusionAuthClient) RetrieveFormField(fieldId string) (*FormFieldResponse, error)

RetrieveFormField Retrieves the form field with the given Id. 

string fieldId The Id of the form field.

func (*FusionAuthClient) RetrieveFormFieldWithContext 

func (c *FusionAuthClient) RetrieveFormFieldWithContext(ctx context.Context, fieldId string) (*FormFieldResponse, error)

RetrieveFormFieldWithContext Retrieves the form field with the given Id. 

string fieldId The Id of the form field.

func (*FusionAuthClient) RetrieveFormFields 

func (c *FusionAuthClient) RetrieveFormFields() (*FormFieldResponse, error)

RetrieveFormFields Retrieves all the forms fields

func (*FusionAuthClient) RetrieveFormFieldsWithContext 

func (c *FusionAuthClient) RetrieveFormFieldsWithContext(ctx context.Context) (*FormFieldResponse, error)

RetrieveFormFieldsWithContext Retrieves all the forms fields

func (*FusionAuthClient) RetrieveFormWithContext 

func (c *FusionAuthClient) RetrieveFormWithContext(ctx context.Context, formId string) (*FormResponse, error)

RetrieveFormWithContext Retrieves the form with the given Id. 

string formId The Id of the form.

func (*FusionAuthClient) RetrieveForms 

func (c *FusionAuthClient) RetrieveForms() (*FormResponse, error)

RetrieveForms Retrieves all the forms.

func (*FusionAuthClient) RetrieveFormsWithContext 

func (c *FusionAuthClient) RetrieveFormsWithContext(ctx context.Context) (*FormResponse, error)

RetrieveFormsWithContext Retrieves all the forms.

func (*FusionAuthClient) RetrieveGroup 

func (c *FusionAuthClient) RetrieveGroup(groupId string) (*GroupResponse, *Errors, error)

RetrieveGroup Retrieves the group for the given Id. 

string groupId The Id of the group.

func (*FusionAuthClient) RetrieveGroupWithContext 

func (c *FusionAuthClient) RetrieveGroupWithContext(ctx context.Context, groupId string) (*GroupResponse, *Errors, error)

RetrieveGroupWithContext Retrieves the group for the given Id. 

string groupId The Id of the group.

func (*FusionAuthClient) RetrieveGroups 

func (c *FusionAuthClient) RetrieveGroups() (*GroupResponse, error)

RetrieveGroups Retrieves all the groups.

func (*FusionAuthClient) RetrieveGroupsWithContext 

func (c *FusionAuthClient) RetrieveGroupsWithContext(ctx context.Context) (*GroupResponse, error)

RetrieveGroupsWithContext Retrieves all the groups.

func (*FusionAuthClient) RetrieveIPAccessControlList 

func (c *FusionAuthClient) RetrieveIPAccessControlList(ipAccessControlListId string) (*IPAccessControlListResponse, error)

RetrieveIPAccessControlList Retrieves the IP Access Control List with the given Id. 

string ipAccessControlListId The Id of the IP Access Control List.

func (*FusionAuthClient) RetrieveIPAccessControlListWithContext 

func (c *FusionAuthClient) RetrieveIPAccessControlListWithContext(ctx context.Context, ipAccessControlListId string) (*IPAccessControlListResponse, error)

RetrieveIPAccessControlListWithContext Retrieves the IP Access Control List with the given Id. 

string ipAccessControlListId The Id of the IP Access Control List.

func (*FusionAuthClient) RetrieveIdentityProviderByType 

func (c *FusionAuthClient) RetrieveIdentityProviderByType(_type IdentityProviderType) (*IdentityProviderResponse, *Errors, error)

RetrieveIdentityProviderByType Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request may return multiple identity providers. 

IdentityProviderType _type The type of the identity provider.

func (*FusionAuthClient) RetrieveIdentityProviderByTypeWithContext 

func (c *FusionAuthClient) RetrieveIdentityProviderByTypeWithContext(ctx context.Context, _type IdentityProviderType) (*IdentityProviderResponse, *Errors, error)

RetrieveIdentityProviderByTypeWithContext Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request may return multiple identity providers. 

IdentityProviderType _type The type of the identity provider.

func (*FusionAuthClient) RetrieveInactiveActions 

func (c *FusionAuthClient) RetrieveInactiveActions(userId string) (*ActionResponse, *Errors, error)

RetrieveInactiveActions Retrieves all the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or has expired, or is not time based. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveInactiveActionsWithContext 

func (c *FusionAuthClient) RetrieveInactiveActionsWithContext(ctx context.Context, userId string) (*ActionResponse, *Errors, error)

RetrieveInactiveActionsWithContext Retrieves all the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or has expired, or is not time based. 

string userId The Id of the user to fetch the actions for.

func (*FusionAuthClient) RetrieveInactiveApplications 

func (c *FusionAuthClient) RetrieveInactiveApplications() (*ApplicationResponse, error)

RetrieveInactiveApplications Retrieves all the applications that are currently inactive.

func (*FusionAuthClient) RetrieveInactiveApplicationsWithContext 

func (c *FusionAuthClient) RetrieveInactiveApplicationsWithContext(ctx context.Context) (*ApplicationResponse, error)

RetrieveInactiveApplicationsWithContext Retrieves all the applications that are currently inactive.

func (*FusionAuthClient) RetrieveInactiveUserActions 

func (c *FusionAuthClient) RetrieveInactiveUserActions() (*UserActionResponse, error)

RetrieveInactiveUserActions Retrieves all the user actions that are currently inactive.

func (*FusionAuthClient) RetrieveInactiveUserActionsWithContext 

func (c *FusionAuthClient) RetrieveInactiveUserActionsWithContext(ctx context.Context) (*UserActionResponse, error)

RetrieveInactiveUserActionsWithContext Retrieves all the user actions that are currently inactive.

func (*FusionAuthClient) RetrieveIntegration 

func (c *FusionAuthClient) RetrieveIntegration() (*IntegrationResponse, error)

RetrieveIntegration Retrieves the available integrations.

func (*FusionAuthClient) RetrieveIntegrationWithContext 

func (c *FusionAuthClient) RetrieveIntegrationWithContext(ctx context.Context) (*IntegrationResponse, error)

RetrieveIntegrationWithContext Retrieves the available integrations.

func (*FusionAuthClient) RetrieveJWTPublicKey 

func (c *FusionAuthClient) RetrieveJWTPublicKey(keyId string) (*PublicKeyResponse, error)

RetrieveJWTPublicKey Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid). 

string keyId The Id of the public key (kid).

func (*FusionAuthClient) RetrieveJWTPublicKeyByApplicationId 

func (c *FusionAuthClient) RetrieveJWTPublicKeyByApplicationId(applicationId string) (*PublicKeyResponse, error)

RetrieveJWTPublicKeyByApplicationId Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id. 

string applicationId The Id of the Application for which this key is used.

func (*FusionAuthClient) RetrieveJWTPublicKeyByApplicationIdWithContext 

func (c *FusionAuthClient) RetrieveJWTPublicKeyByApplicationIdWithContext(ctx context.Context, applicationId string) (*PublicKeyResponse, error)

RetrieveJWTPublicKeyByApplicationIdWithContext Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id. 

string applicationId The Id of the Application for which this key is used.

func (*FusionAuthClient) RetrieveJWTPublicKeyWithContext 

func (c *FusionAuthClient) RetrieveJWTPublicKeyWithContext(ctx context.Context, keyId string) (*PublicKeyResponse, error)

RetrieveJWTPublicKeyWithContext Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid). 

string keyId The Id of the public key (kid).

func (*FusionAuthClient) RetrieveJWTPublicKeys 

func (c *FusionAuthClient) RetrieveJWTPublicKeys() (*PublicKeyResponse, error)

RetrieveJWTPublicKeys Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).

func (*FusionAuthClient) RetrieveJWTPublicKeysWithContext 

func (c *FusionAuthClient) RetrieveJWTPublicKeysWithContext(ctx context.Context) (*PublicKeyResponse, error)

RetrieveJWTPublicKeysWithContext Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).

func (*FusionAuthClient) RetrieveJsonWebKeySet 

func (c *FusionAuthClient) RetrieveJsonWebKeySet() (*JWKSResponse, error)

RetrieveJsonWebKeySet Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.

func (*FusionAuthClient) RetrieveJsonWebKeySetWithContext 

func (c *FusionAuthClient) RetrieveJsonWebKeySetWithContext(ctx context.Context) (*JWKSResponse, error)

RetrieveJsonWebKeySetWithContext Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.

func (*FusionAuthClient) RetrieveKey 

func (c *FusionAuthClient) RetrieveKey(keyId string) (*KeyResponse, *Errors, error)

RetrieveKey Retrieves the key for the given Id. 

string keyId The Id of the key.

func (*FusionAuthClient) RetrieveKeyWithContext 

func (c *FusionAuthClient) RetrieveKeyWithContext(ctx context.Context, keyId string) (*KeyResponse, *Errors, error)

RetrieveKeyWithContext Retrieves the key for the given Id. 

string keyId The Id of the key.

func (*FusionAuthClient) RetrieveKeys 

func (c *FusionAuthClient) RetrieveKeys() (*KeyResponse, error)

RetrieveKeys Retrieves all the keys.

func (*FusionAuthClient) RetrieveKeysWithContext 

func (c *FusionAuthClient) RetrieveKeysWithContext(ctx context.Context) (*KeyResponse, error)

RetrieveKeysWithContext Retrieves all the keys.

func (*FusionAuthClient) RetrieveLambda 

func (c *FusionAuthClient) RetrieveLambda(lambdaId string) (*LambdaResponse, *Errors, error)

RetrieveLambda Retrieves the lambda for the given Id. 

string lambdaId The Id of the lambda.

func (*FusionAuthClient) RetrieveLambdaWithContext 

func (c *FusionAuthClient) RetrieveLambdaWithContext(ctx context.Context, lambdaId string) (*LambdaResponse, *Errors, error)

RetrieveLambdaWithContext Retrieves the lambda for the given Id. 

string lambdaId The Id of the lambda.

func (*FusionAuthClient) RetrieveLambdas 

func (c *FusionAuthClient) RetrieveLambdas() (*LambdaResponse, error)

RetrieveLambdas Retrieves all the lambdas.

func (*FusionAuthClient) RetrieveLambdasByType 

func (c *FusionAuthClient) RetrieveLambdasByType(_type LambdaType) (*LambdaResponse, error)

RetrieveLambdasByType Retrieves all the lambdas for the provided type. 

LambdaType _type The type of the lambda to return.

func (*FusionAuthClient) RetrieveLambdasByTypeWithContext 

func (c *FusionAuthClient) RetrieveLambdasByTypeWithContext(ctx context.Context, _type LambdaType) (*LambdaResponse, error)

RetrieveLambdasByTypeWithContext Retrieves all the lambdas for the provided type. 

LambdaType _type The type of the lambda to return.

func (*FusionAuthClient) RetrieveLambdasWithContext 

func (c *FusionAuthClient) RetrieveLambdasWithContext(ctx context.Context) (*LambdaResponse, error)

RetrieveLambdasWithContext Retrieves all the lambdas.

func (*FusionAuthClient) RetrieveLoginReport 

func (c *FusionAuthClient) RetrieveLoginReport(applicationId string, start int64, end int64) (*LoginReportResponse, *Errors, error)

RetrieveLoginReport Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveLoginReportWithContext 

func (c *FusionAuthClient) RetrieveLoginReportWithContext(ctx context.Context, applicationId string, start int64, end int64) (*LoginReportResponse, *Errors, error)

RetrieveLoginReportWithContext Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveMessageTemplate 

func (c *FusionAuthClient) RetrieveMessageTemplate(messageTemplateId string) (*MessageTemplateResponse, error)

RetrieveMessageTemplate Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates. 

string messageTemplateId (Optional) The Id of the message template.

func (*FusionAuthClient) RetrieveMessageTemplatePreview 

func (c *FusionAuthClient) RetrieveMessageTemplatePreview(request PreviewMessageTemplateRequest) (*PreviewMessageTemplateResponse, *Errors, error)

RetrieveMessageTemplatePreview Creates a preview of the message template provided in the request, normalized to a given locale. 

PreviewMessageTemplateRequest request The request that contains the email template and optionally a locale to render it in.

func (*FusionAuthClient) RetrieveMessageTemplatePreviewWithContext 

func (c *FusionAuthClient) RetrieveMessageTemplatePreviewWithContext(ctx context.Context, request PreviewMessageTemplateRequest) (*PreviewMessageTemplateResponse, *Errors, error)

RetrieveMessageTemplatePreviewWithContext Creates a preview of the message template provided in the request, normalized to a given locale. 

PreviewMessageTemplateRequest request The request that contains the email template and optionally a locale to render it in.

func (*FusionAuthClient) RetrieveMessageTemplateWithContext 

func (c *FusionAuthClient) RetrieveMessageTemplateWithContext(ctx context.Context, messageTemplateId string) (*MessageTemplateResponse, error)

RetrieveMessageTemplateWithContext Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates. 

string messageTemplateId (Optional) The Id of the message template.

func (*FusionAuthClient) RetrieveMessageTemplates 

func (c *FusionAuthClient) RetrieveMessageTemplates() (*MessageTemplateResponse, error)

RetrieveMessageTemplates Retrieves all the message templates.

func (*FusionAuthClient) RetrieveMessageTemplatesWithContext 

func (c *FusionAuthClient) RetrieveMessageTemplatesWithContext(ctx context.Context) (*MessageTemplateResponse, error)

RetrieveMessageTemplatesWithContext Retrieves all the message templates.

func (*FusionAuthClient) RetrieveMessenger 

func (c *FusionAuthClient) RetrieveMessenger(messengerId string) (*MessengerResponse, error)

RetrieveMessenger Retrieves the messenger with the given Id. 

string messengerId The Id of the messenger.

func (*FusionAuthClient) RetrieveMessengerWithContext 

func (c *FusionAuthClient) RetrieveMessengerWithContext(ctx context.Context, messengerId string) (*MessengerResponse, error)

RetrieveMessengerWithContext Retrieves the messenger with the given Id. 

string messengerId The Id of the messenger.

func (*FusionAuthClient) RetrieveMessengers 

func (c *FusionAuthClient) RetrieveMessengers() (*MessengerResponse, error)

RetrieveMessengers Retrieves all the messengers.

func (*FusionAuthClient) RetrieveMessengersWithContext 

func (c *FusionAuthClient) RetrieveMessengersWithContext(ctx context.Context) (*MessengerResponse, error)

RetrieveMessengersWithContext Retrieves all the messengers.

func (*FusionAuthClient) RetrieveMonthlyActiveReport 

func (c *FusionAuthClient) RetrieveMonthlyActiveReport(applicationId string, start int64, end int64) (*MonthlyActiveUserReportResponse, *Errors, error)

RetrieveMonthlyActiveReport Retrieves the monthly active user report between the two instants. If you specify an application id, it will only return the monthly active counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveMonthlyActiveReportWithContext 

func (c *FusionAuthClient) RetrieveMonthlyActiveReportWithContext(ctx context.Context, applicationId string, start int64, end int64) (*MonthlyActiveUserReportResponse, *Errors, error)

RetrieveMonthlyActiveReportWithContext Retrieves the monthly active user report between the two instants. If you specify an application id, it will only return the monthly active counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveOAuthScope 

func (c *FusionAuthClient) RetrieveOAuthScope(applicationId string, scopeId string) (*ApplicationOAuthScopeResponse, *Errors, error)

RetrieveOAuthScope Retrieves a custom OAuth scope. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to retrieve.

func (*FusionAuthClient) RetrieveOAuthScopeWithContext 

func (c *FusionAuthClient) RetrieveOAuthScopeWithContext(ctx context.Context, applicationId string, scopeId string) (*ApplicationOAuthScopeResponse, *Errors, error)

RetrieveOAuthScopeWithContext Retrieves a custom OAuth scope. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to retrieve.

func (*FusionAuthClient) RetrieveOauthConfiguration 

func (c *FusionAuthClient) RetrieveOauthConfiguration(applicationId string) (*OAuthConfigurationResponse, *Errors, error)

RetrieveOauthConfiguration Retrieves the Oauth2 configuration for the application for the given Application Id. 

string applicationId The Id of the Application to retrieve OAuth configuration.

func (*FusionAuthClient) RetrieveOauthConfigurationWithContext 

func (c *FusionAuthClient) RetrieveOauthConfigurationWithContext(ctx context.Context, applicationId string) (*OAuthConfigurationResponse, *Errors, error)

RetrieveOauthConfigurationWithContext Retrieves the Oauth2 configuration for the application for the given Application Id. 

string applicationId The Id of the Application to retrieve OAuth configuration.

func (*FusionAuthClient) RetrieveOpenIdConfiguration 

func (c *FusionAuthClient) RetrieveOpenIdConfiguration() (*OpenIdConfiguration, error)

RetrieveOpenIdConfiguration Returns the well known OpenID Configuration JSON document

func (*FusionAuthClient) RetrieveOpenIdConfigurationWithContext 

func (c *FusionAuthClient) RetrieveOpenIdConfigurationWithContext(ctx context.Context) (*OpenIdConfiguration, error)

RetrieveOpenIdConfigurationWithContext Returns the well known OpenID Configuration JSON document

func (*FusionAuthClient) RetrievePasswordValidationRules 

func (c *FusionAuthClient) RetrievePasswordValidationRules() (*PasswordValidationRulesResponse, error)

RetrievePasswordValidationRules Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.

This API does not require an API key.

func (*FusionAuthClient) RetrievePasswordValidationRulesWithContext 

func (c *FusionAuthClient) RetrievePasswordValidationRulesWithContext(ctx context.Context) (*PasswordValidationRulesResponse, error)

RetrievePasswordValidationRulesWithContext Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.

This API does not require an API key.

func (*FusionAuthClient) RetrievePasswordValidationRulesWithTenantId 

func (c *FusionAuthClient) RetrievePasswordValidationRulesWithTenantId(tenantId string) (*PasswordValidationRulesResponse, error)

RetrievePasswordValidationRulesWithTenantId Retrieves the password validation rules for a specific tenant.

This API does not require an API key. 

string tenantId The Id of the tenant.

func (*FusionAuthClient) RetrievePasswordValidationRulesWithTenantIdWithContext 

func (c *FusionAuthClient) RetrievePasswordValidationRulesWithTenantIdWithContext(ctx context.Context, tenantId string) (*PasswordValidationRulesResponse, error)

RetrievePasswordValidationRulesWithTenantIdWithContext Retrieves the password validation rules for a specific tenant.

This API does not require an API key. 

string tenantId The Id of the tenant.

func (*FusionAuthClient) RetrievePendingChildren 

func (c *FusionAuthClient) RetrievePendingChildren(parentEmail string) (*PendingResponse, *Errors, error)

RetrievePendingChildren Retrieves all the children for the given parent email address. 

string parentEmail The email of the parent.

func (*FusionAuthClient) RetrievePendingChildrenWithContext 

func (c *FusionAuthClient) RetrievePendingChildrenWithContext(ctx context.Context, parentEmail string) (*PendingResponse, *Errors, error)

RetrievePendingChildrenWithContext Retrieves all the children for the given parent email address. 

string parentEmail The email of the parent.

func (c *FusionAuthClient) RetrievePendingLink(pendingLinkId string, userId string) (*IdentityProviderPendingLinkResponse, *Errors, error)

RetrievePendingLink Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link. 

string pendingLinkId The pending link Id.
string userId The optional userId. When provided additional meta-data will be provided to identify how many links if any the user already has.

func (*FusionAuthClient) RetrievePendingLinkWithContext 

func (c *FusionAuthClient) RetrievePendingLinkWithContext(ctx context.Context, pendingLinkId string, userId string) (*IdentityProviderPendingLinkResponse, *Errors, error)

RetrievePendingLinkWithContext Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link. 

string pendingLinkId The pending link Id.
string userId The optional userId. When provided additional meta-data will be provided to identify how many links if any the user already has.

func (*FusionAuthClient) RetrieveReactorMetrics 

func (c *FusionAuthClient) RetrieveReactorMetrics() (*ReactorMetricsResponse, error)

RetrieveReactorMetrics Retrieves the FusionAuth Reactor metrics.

func (*FusionAuthClient) RetrieveReactorMetricsWithContext 

func (c *FusionAuthClient) RetrieveReactorMetricsWithContext(ctx context.Context) (*ReactorMetricsResponse, error)

RetrieveReactorMetricsWithContext Retrieves the FusionAuth Reactor metrics.

func (*FusionAuthClient) RetrieveReactorStatus 

func (c *FusionAuthClient) RetrieveReactorStatus() (*ReactorResponse, error)

RetrieveReactorStatus Retrieves the FusionAuth Reactor status.

func (*FusionAuthClient) RetrieveReactorStatusWithContext 

func (c *FusionAuthClient) RetrieveReactorStatusWithContext(ctx context.Context) (*ReactorResponse, error)

RetrieveReactorStatusWithContext Retrieves the FusionAuth Reactor status.

func (*FusionAuthClient) RetrieveRecentLogins 

func (c *FusionAuthClient) RetrieveRecentLogins(offset int, limit int) (*RecentLoginResponse, *Errors, error)

RetrieveRecentLogins Retrieves the last number of login records. 

int offset The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
int limit (Optional, defaults to 10) The number of records to retrieve.

func (*FusionAuthClient) RetrieveRecentLoginsWithContext 

func (c *FusionAuthClient) RetrieveRecentLoginsWithContext(ctx context.Context, offset int, limit int) (*RecentLoginResponse, *Errors, error)

RetrieveRecentLoginsWithContext Retrieves the last number of login records. 

int offset The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
int limit (Optional, defaults to 10) The number of records to retrieve.

func (*FusionAuthClient) RetrieveRefreshTokenById 

func (c *FusionAuthClient) RetrieveRefreshTokenById(tokenId string) (*RefreshTokenResponse, *Errors, error)

RetrieveRefreshTokenById Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need. 

string tokenId The Id of the token.

func (*FusionAuthClient) RetrieveRefreshTokenByIdWithContext 

func (c *FusionAuthClient) RetrieveRefreshTokenByIdWithContext(ctx context.Context, tokenId string) (*RefreshTokenResponse, *Errors, error)

RetrieveRefreshTokenByIdWithContext Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need. 

string tokenId The Id of the token.

func (*FusionAuthClient) RetrieveRefreshTokens 

func (c *FusionAuthClient) RetrieveRefreshTokens(userId string) (*RefreshTokenResponse, *Errors, error)

RetrieveRefreshTokens Retrieves the refresh tokens that belong to the user with the given Id. 

string userId The Id of the user.

func (*FusionAuthClient) RetrieveRefreshTokensWithContext 

func (c *FusionAuthClient) RetrieveRefreshTokensWithContext(ctx context.Context, userId string) (*RefreshTokenResponse, *Errors, error)

RetrieveRefreshTokensWithContext Retrieves the refresh tokens that belong to the user with the given Id. 

string userId The Id of the user.

func (*FusionAuthClient) RetrieveRegistration 

func (c *FusionAuthClient) RetrieveRegistration(userId string, applicationId string) (*RegistrationResponse, *Errors, error)

RetrieveRegistration Retrieves the user registration for the user with the given Id and the given application id. 

string userId The Id of the user.
string applicationId The Id of the application.

func (*FusionAuthClient) RetrieveRegistrationReport 

func (c *FusionAuthClient) RetrieveRegistrationReport(applicationId string, start int64, end int64) (*RegistrationReportResponse, *Errors, error)

RetrieveRegistrationReport Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveRegistrationReportWithContext 

func (c *FusionAuthClient) RetrieveRegistrationReportWithContext(ctx context.Context, applicationId string, start int64, end int64) (*RegistrationReportResponse, *Errors, error)

RetrieveRegistrationReportWithContext Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application. 

string applicationId (Optional) The application id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveRegistrationWithContext 

func (c *FusionAuthClient) RetrieveRegistrationWithContext(ctx context.Context, userId string, applicationId string) (*RegistrationResponse, *Errors, error)

RetrieveRegistrationWithContext Retrieves the user registration for the user with the given Id and the given application id. 

string userId The Id of the user.
string applicationId The Id of the application.

func (*FusionAuthClient) RetrieveReindexStatus 

func (c *FusionAuthClient) RetrieveReindexStatus() (*BaseHTTPResponse, *Errors, error)

RetrieveReindexStatus Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of 404 indicates no re-index is in progress.

func (*FusionAuthClient) RetrieveReindexStatusWithContext 

func (c *FusionAuthClient) RetrieveReindexStatusWithContext(ctx context.Context) (*BaseHTTPResponse, *Errors, error)

RetrieveReindexStatusWithContext Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of 404 indicates no re-index is in progress.

func (*FusionAuthClient) RetrieveSystemConfiguration 

func (c *FusionAuthClient) RetrieveSystemConfiguration() (*SystemConfigurationResponse, error)

RetrieveSystemConfiguration Retrieves the system configuration.

func (*FusionAuthClient) RetrieveSystemConfigurationWithContext 

func (c *FusionAuthClient) RetrieveSystemConfigurationWithContext(ctx context.Context) (*SystemConfigurationResponse, error)

RetrieveSystemConfigurationWithContext Retrieves the system configuration.

func (*FusionAuthClient) RetrieveSystemHealth 

func (c *FusionAuthClient) RetrieveSystemHealth() (*BaseHTTPResponse, error)

RetrieveSystemHealth Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.

func (*FusionAuthClient) RetrieveSystemHealthWithContext 

func (c *FusionAuthClient) RetrieveSystemHealthWithContext(ctx context.Context) (*BaseHTTPResponse, error)

RetrieveSystemHealthWithContext Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.

func (*FusionAuthClient) RetrieveSystemStatus 

func (c *FusionAuthClient) RetrieveSystemStatus() (*StatusResponse, error)

RetrieveSystemStatus Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.

func (*FusionAuthClient) RetrieveSystemStatusUsingAPIKey 

func (c *FusionAuthClient) RetrieveSystemStatusUsingAPIKey() (*StatusResponse, error)

RetrieveSystemStatusUsingAPIKey Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.

func (*FusionAuthClient) RetrieveSystemStatusUsingAPIKeyWithContext 

func (c *FusionAuthClient) RetrieveSystemStatusUsingAPIKeyWithContext(ctx context.Context) (*StatusResponse, error)

RetrieveSystemStatusUsingAPIKeyWithContext Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.

func (*FusionAuthClient) RetrieveSystemStatusWithContext 

func (c *FusionAuthClient) RetrieveSystemStatusWithContext(ctx context.Context) (*StatusResponse, error)

RetrieveSystemStatusWithContext Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.

func (*FusionAuthClient) RetrieveTenant 

func (c *FusionAuthClient) RetrieveTenant(tenantId string) (*TenantResponse, *Errors, error)

RetrieveTenant Retrieves the tenant for the given Id. 

string tenantId The Id of the tenant.

func (*FusionAuthClient) RetrieveTenantWithContext 

func (c *FusionAuthClient) RetrieveTenantWithContext(ctx context.Context, tenantId string) (*TenantResponse, *Errors, error)

RetrieveTenantWithContext Retrieves the tenant for the given Id. 

string tenantId The Id of the tenant.

func (*FusionAuthClient) RetrieveTenants 

func (c *FusionAuthClient) RetrieveTenants() (*TenantResponse, error)

RetrieveTenants Retrieves all the tenants.

func (*FusionAuthClient) RetrieveTenantsWithContext 

func (c *FusionAuthClient) RetrieveTenantsWithContext(ctx context.Context) (*TenantResponse, error)

RetrieveTenantsWithContext Retrieves all the tenants.

func (*FusionAuthClient) RetrieveTheme 

func (c *FusionAuthClient) RetrieveTheme(themeId string) (*ThemeResponse, *Errors, error)

RetrieveTheme Retrieves the theme for the given Id. 

string themeId The Id of the theme.

func (*FusionAuthClient) RetrieveThemeWithContext 

func (c *FusionAuthClient) RetrieveThemeWithContext(ctx context.Context, themeId string) (*ThemeResponse, *Errors, error)

RetrieveThemeWithContext Retrieves the theme for the given Id. 

string themeId The Id of the theme.

func (*FusionAuthClient) RetrieveThemes 

func (c *FusionAuthClient) RetrieveThemes() (*ThemeResponse, error)

RetrieveThemes Retrieves all the themes.

func (*FusionAuthClient) RetrieveThemesWithContext 

func (c *FusionAuthClient) RetrieveThemesWithContext(ctx context.Context) (*ThemeResponse, error)

RetrieveThemesWithContext Retrieves all the themes.

func (*FusionAuthClient) RetrieveTotalReport 

func (c *FusionAuthClient) RetrieveTotalReport() (*TotalsReportResponse, error)

RetrieveTotalReport Retrieves the totals report. This contains all the total counts for each application and the global registration count.

func (*FusionAuthClient) RetrieveTotalReportWithContext 

func (c *FusionAuthClient) RetrieveTotalReportWithContext(ctx context.Context) (*TotalsReportResponse, error)

RetrieveTotalReportWithContext Retrieves the totals report. This contains all the total counts for each application and the global registration count.

func (*FusionAuthClient) RetrieveTwoFactorRecoveryCodes 

func (c *FusionAuthClient) RetrieveTwoFactorRecoveryCodes(userId string) (*TwoFactorRecoveryCodeResponse, *Errors, error)

RetrieveTwoFactorRecoveryCodes Retrieve two-factor recovery codes for a user. 

string userId The Id of the user to retrieve Two Factor recovery codes.

func (*FusionAuthClient) RetrieveTwoFactorRecoveryCodesWithContext 

func (c *FusionAuthClient) RetrieveTwoFactorRecoveryCodesWithContext(ctx context.Context, userId string) (*TwoFactorRecoveryCodeResponse, *Errors, error)

RetrieveTwoFactorRecoveryCodesWithContext Retrieve two-factor recovery codes for a user. 

string userId The Id of the user to retrieve Two Factor recovery codes.

func (*FusionAuthClient) RetrieveTwoFactorStatus 

func (c *FusionAuthClient) RetrieveTwoFactorStatus(userId string, applicationId string, twoFactorTrustId string) (*TwoFactorStatusResponse, *Errors, error)

RetrieveTwoFactorStatus Retrieve a user's two-factor status.

This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications. 

string userId The user Id to retrieve the Two-Factor status.
string applicationId The optional applicationId to verify.
string twoFactorTrustId The optional two-factor trust Id to verify.

func (*FusionAuthClient) RetrieveTwoFactorStatusWithContext 

func (c *FusionAuthClient) RetrieveTwoFactorStatusWithContext(ctx context.Context, userId string, applicationId string, twoFactorTrustId string) (*TwoFactorStatusResponse, *Errors, error)

RetrieveTwoFactorStatusWithContext Retrieve a user's two-factor status.

This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications. 

string userId The user Id to retrieve the Two-Factor status.
string applicationId The optional applicationId to verify.
string twoFactorTrustId The optional two-factor trust Id to verify.

func (*FusionAuthClient) RetrieveUser 

func (c *FusionAuthClient) RetrieveUser(userId string) (*UserResponse, *Errors, error)

RetrieveUser Retrieves the user for the given Id. 

string userId The Id of the user.

func (*FusionAuthClient) RetrieveUserAction 

func (c *FusionAuthClient) RetrieveUserAction(userActionId string) (*UserActionResponse, error)

RetrieveUserAction Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user actions. 

string userActionId (Optional) The Id of the user action.

func (*FusionAuthClient) RetrieveUserActionReason 

func (c *FusionAuthClient) RetrieveUserActionReason(userActionReasonId string) (*UserActionReasonResponse, error)

RetrieveUserActionReason Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user action reasons. 

string userActionReasonId (Optional) The Id of the user action reason.

func (*FusionAuthClient) RetrieveUserActionReasonWithContext 

func (c *FusionAuthClient) RetrieveUserActionReasonWithContext(ctx context.Context, userActionReasonId string) (*UserActionReasonResponse, error)

RetrieveUserActionReasonWithContext Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user action reasons. 

string userActionReasonId (Optional) The Id of the user action reason.

func (*FusionAuthClient) RetrieveUserActionReasons 

func (c *FusionAuthClient) RetrieveUserActionReasons() (*UserActionReasonResponse, error)

RetrieveUserActionReasons Retrieves all the user action reasons.

func (*FusionAuthClient) RetrieveUserActionReasonsWithContext 

func (c *FusionAuthClient) RetrieveUserActionReasonsWithContext(ctx context.Context) (*UserActionReasonResponse, error)

RetrieveUserActionReasonsWithContext Retrieves all the user action reasons.

func (*FusionAuthClient) RetrieveUserActionWithContext 

func (c *FusionAuthClient) RetrieveUserActionWithContext(ctx context.Context, userActionId string) (*UserActionResponse, error)

RetrieveUserActionWithContext Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user actions. 

string userActionId (Optional) The Id of the user action.

func (*FusionAuthClient) RetrieveUserActions 

func (c *FusionAuthClient) RetrieveUserActions() (*UserActionResponse, error)

RetrieveUserActions Retrieves all the user actions.

func (*FusionAuthClient) RetrieveUserActionsWithContext 

func (c *FusionAuthClient) RetrieveUserActionsWithContext(ctx context.Context) (*UserActionResponse, error)

RetrieveUserActionsWithContext Retrieves all the user actions.

func (*FusionAuthClient) RetrieveUserByChangePasswordId 

func (c *FusionAuthClient) RetrieveUserByChangePasswordId(changePasswordId string) (*UserResponse, *Errors, error)

RetrieveUserByChangePasswordId Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username. 

string changePasswordId The unique change password Id that was sent via email or returned by the Forgot Password API.

func (*FusionAuthClient) RetrieveUserByChangePasswordIdWithContext 

func (c *FusionAuthClient) RetrieveUserByChangePasswordIdWithContext(ctx context.Context, changePasswordId string) (*UserResponse, *Errors, error)

RetrieveUserByChangePasswordIdWithContext Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username. 

string changePasswordId The unique change password Id that was sent via email or returned by the Forgot Password API.

func (*FusionAuthClient) RetrieveUserByEmail 

func (c *FusionAuthClient) RetrieveUserByEmail(email string) (*UserResponse, *Errors, error)

RetrieveUserByEmail Retrieves the user for the given email. 

string email The email of the user.

func (*FusionAuthClient) RetrieveUserByEmailWithContext 

func (c *FusionAuthClient) RetrieveUserByEmailWithContext(ctx context.Context, email string) (*UserResponse, *Errors, error)

RetrieveUserByEmailWithContext Retrieves the user for the given email. 

string email The email of the user.

func (*FusionAuthClient) RetrieveUserByLoginId 

func (c *FusionAuthClient) RetrieveUserByLoginId(loginId string) (*UserResponse, *Errors, error)

RetrieveUserByLoginId Retrieves the user for the loginId. The loginId can be either the username or the email. 

string loginId The email or username of the user.

func (*FusionAuthClient) RetrieveUserByLoginIdWithContext 

func (c *FusionAuthClient) RetrieveUserByLoginIdWithContext(ctx context.Context, loginId string) (*UserResponse, *Errors, error)

RetrieveUserByLoginIdWithContext Retrieves the user for the loginId. The loginId can be either the username or the email. 

string loginId The email or username of the user.

func (*FusionAuthClient) RetrieveUserByUsername 

func (c *FusionAuthClient) RetrieveUserByUsername(username string) (*UserResponse, *Errors, error)

RetrieveUserByUsername Retrieves the user for the given username. 

string username The username of the user.

func (*FusionAuthClient) RetrieveUserByUsernameWithContext 

func (c *FusionAuthClient) RetrieveUserByUsernameWithContext(ctx context.Context, username string) (*UserResponse, *Errors, error)

RetrieveUserByUsernameWithContext Retrieves the user for the given username. 

string username The username of the user.

func (*FusionAuthClient) RetrieveUserByVerificationId 

func (c *FusionAuthClient) RetrieveUserByVerificationId(verificationId string) (*UserResponse, *Errors, error)

RetrieveUserByVerificationId Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username. 

string verificationId The unique verification Id that has been set on the user object.

func (*FusionAuthClient) RetrieveUserByVerificationIdWithContext 

func (c *FusionAuthClient) RetrieveUserByVerificationIdWithContext(ctx context.Context, verificationId string) (*UserResponse, *Errors, error)

RetrieveUserByVerificationIdWithContext Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username. 

string verificationId The unique verification Id that has been set on the user object.

func (*FusionAuthClient) RetrieveUserCode 

func (c *FusionAuthClient) RetrieveUserCode(clientId string, clientSecret string, userCode string) (*BaseHTTPResponse, error)

RetrieveUserCode Retrieve a user_code that is part of an in-progress Device Authorization Grant.

This API is useful if you want to build your own login workflow to complete a device grant. 

string clientId The client id.
string clientSecret The client id.
string userCode The end-user verification code.

func (*FusionAuthClient) RetrieveUserCodeUsingAPIKey 

func (c *FusionAuthClient) RetrieveUserCodeUsingAPIKey(userCode string) (*BaseHTTPResponse, error)

RetrieveUserCodeUsingAPIKey Retrieve a user_code that is part of an in-progress Device Authorization Grant.

This API is useful if you want to build your own login workflow to complete a device grant.

This request will require an API key. 

string userCode The end-user verification code.

func (*FusionAuthClient) RetrieveUserCodeUsingAPIKeyWithContext 

func (c *FusionAuthClient) RetrieveUserCodeUsingAPIKeyWithContext(ctx context.Context, userCode string) (*BaseHTTPResponse, error)

RetrieveUserCodeUsingAPIKeyWithContext Retrieve a user_code that is part of an in-progress Device Authorization Grant.

This API is useful if you want to build your own login workflow to complete a device grant.

This request will require an API key. 

string userCode The end-user verification code.

func (*FusionAuthClient) RetrieveUserCodeWithContext 

func (c *FusionAuthClient) RetrieveUserCodeWithContext(ctx context.Context, clientId string, clientSecret string, userCode string) (*BaseHTTPResponse, error)

RetrieveUserCodeWithContext Retrieve a user_code that is part of an in-progress Device Authorization Grant.

This API is useful if you want to build your own login workflow to complete a device grant. 

string clientId The client id.
string clientSecret The client id.
string userCode The end-user verification code.

func (*FusionAuthClient) RetrieveUserComments 

func (c *FusionAuthClient) RetrieveUserComments(userId string) (*UserCommentResponse, *Errors, error)

RetrieveUserComments Retrieves all the comments for the user with the given Id. 

string userId The Id of the user.

func (*FusionAuthClient) RetrieveUserCommentsWithContext 

func (c *FusionAuthClient) RetrieveUserCommentsWithContext(ctx context.Context, userId string) (*UserCommentResponse, *Errors, error)

RetrieveUserCommentsWithContext Retrieves all the comments for the user with the given Id. 

string userId The Id of the user.

func (*FusionAuthClient) RetrieveUserConsent 

func (c *FusionAuthClient) RetrieveUserConsent(userConsentId string) (*UserConsentResponse, error)

RetrieveUserConsent Retrieve a single User consent by Id. 

string userConsentId The User consent Id

func (*FusionAuthClient) RetrieveUserConsentWithContext 

func (c *FusionAuthClient) RetrieveUserConsentWithContext(ctx context.Context, userConsentId string) (*UserConsentResponse, error)

RetrieveUserConsentWithContext Retrieve a single User consent by Id. 

string userConsentId The User consent Id

func (*FusionAuthClient) RetrieveUserConsents 

func (c *FusionAuthClient) RetrieveUserConsents(userId string) (*UserConsentResponse, error)

RetrieveUserConsents Retrieves all the consents for a User. 

string userId The User's Id

func (*FusionAuthClient) RetrieveUserConsentsWithContext 

func (c *FusionAuthClient) RetrieveUserConsentsWithContext(ctx context.Context, userId string) (*UserConsentResponse, error)

RetrieveUserConsentsWithContext Retrieves all the consents for a User. 

string userId The User's Id

func (c *FusionAuthClient) RetrieveUserLink(identityProviderId string, identityProviderUserId string, userId string) (*IdentityProviderLinkResponse, *Errors, error)

RetrieveUserLink Retrieve a single Identity Provider user (link). 

string identityProviderId The unique Id of the identity provider.
string identityProviderUserId The unique Id of the user in the 3rd party identity provider.
string userId The unique Id of the FusionAuth user.

func (*FusionAuthClient) RetrieveUserLinkWithContext 

func (c *FusionAuthClient) RetrieveUserLinkWithContext(ctx context.Context, identityProviderId string, identityProviderUserId string, userId string) (*IdentityProviderLinkResponse, *Errors, error)

RetrieveUserLinkWithContext Retrieve a single Identity Provider user (link). 

string identityProviderId The unique Id of the identity provider.
string identityProviderUserId The unique Id of the user in the 3rd party identity provider.
string userId The unique Id of the FusionAuth user.

func (*FusionAuthClient) RetrieveUserLinksByUserId 

func (c *FusionAuthClient) RetrieveUserLinksByUserId(identityProviderId string, userId string) (*IdentityProviderLinkResponse, *Errors, error)

RetrieveUserLinksByUserId Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP. 

string identityProviderId (Optional) The unique Id of the identity provider. Specify this value to reduce the links returned to those for a particular IdP.
string userId The unique Id of the user.

func (*FusionAuthClient) RetrieveUserLinksByUserIdWithContext 

func (c *FusionAuthClient) RetrieveUserLinksByUserIdWithContext(ctx context.Context, identityProviderId string, userId string) (*IdentityProviderLinkResponse, *Errors, error)

RetrieveUserLinksByUserIdWithContext Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP. 

string identityProviderId (Optional) The unique Id of the identity provider. Specify this value to reduce the links returned to those for a particular IdP.
string userId The unique Id of the user.

func (*FusionAuthClient) RetrieveUserLoginReport 

func (c *FusionAuthClient) RetrieveUserLoginReport(applicationId string, userId string, start int64, end int64) (*LoginReportResponse, *Errors, error)

RetrieveUserLoginReport Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the login counts for that application. 

string applicationId (Optional) The application id.
string userId The userId id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveUserLoginReportByLoginId 

func (c *FusionAuthClient) RetrieveUserLoginReportByLoginId(applicationId string, loginId string, start int64, end int64) (*LoginReportResponse, *Errors, error)

RetrieveUserLoginReportByLoginId Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the login counts for that application. 

string applicationId (Optional) The application id.
string loginId The userId id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveUserLoginReportByLoginIdWithContext 

func (c *FusionAuthClient) RetrieveUserLoginReportByLoginIdWithContext(ctx context.Context, applicationId string, loginId string, start int64, end int64) (*LoginReportResponse, *Errors, error)

RetrieveUserLoginReportByLoginIdWithContext Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the login counts for that application. 

string applicationId (Optional) The application id.
string loginId The userId id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveUserLoginReportWithContext 

func (c *FusionAuthClient) RetrieveUserLoginReportWithContext(ctx context.Context, applicationId string, userId string, start int64, end int64) (*LoginReportResponse, *Errors, error)

RetrieveUserLoginReportWithContext Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the login counts for that application. 

string applicationId (Optional) The application id.
string userId The userId id.
int64 start The start instant as UTC milliseconds since Epoch.
int64 end The end instant as UTC milliseconds since Epoch.

func (*FusionAuthClient) RetrieveUserRecentLogins 

func (c *FusionAuthClient) RetrieveUserRecentLogins(userId string, offset int, limit int) (*RecentLoginResponse, *Errors, error)

RetrieveUserRecentLogins Retrieves the last number of login records for a user. 

string userId The Id of the user.
int offset The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
int limit (Optional, defaults to 10) The number of records to retrieve.

func (*FusionAuthClient) RetrieveUserRecentLoginsWithContext 

func (c *FusionAuthClient) RetrieveUserRecentLoginsWithContext(ctx context.Context, userId string, offset int, limit int) (*RecentLoginResponse, *Errors, error)

RetrieveUserRecentLoginsWithContext Retrieves the last number of login records for a user. 

string userId The Id of the user.
int offset The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
int limit (Optional, defaults to 10) The number of records to retrieve.

func (*FusionAuthClient) RetrieveUserUsingJWT 

func (c *FusionAuthClient) RetrieveUserUsingJWT(encodedJWT string) (*UserResponse, *Errors, error)

RetrieveUserUsingJWT Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web Token (JWT) for authentication. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) RetrieveUserUsingJWTWithContext 

func (c *FusionAuthClient) RetrieveUserUsingJWTWithContext(ctx context.Context, encodedJWT string) (*UserResponse, *Errors, error)

RetrieveUserUsingJWTWithContext Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web Token (JWT) for authentication. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) RetrieveUserWithContext 

func (c *FusionAuthClient) RetrieveUserWithContext(ctx context.Context, userId string) (*UserResponse, *Errors, error)

RetrieveUserWithContext Retrieves the user for the given Id. 

string userId The Id of the user.

func (*FusionAuthClient) RetrieveVersion 

func (c *FusionAuthClient) RetrieveVersion() (*VersionResponse, *Errors, error)

RetrieveVersion Retrieves the FusionAuth version string.

func (*FusionAuthClient) RetrieveVersionWithContext 

func (c *FusionAuthClient) RetrieveVersionWithContext(ctx context.Context) (*VersionResponse, *Errors, error)

RetrieveVersionWithContext Retrieves the FusionAuth version string.

func (*FusionAuthClient) RetrieveWebAuthnCredential 

func (c *FusionAuthClient) RetrieveWebAuthnCredential(id string) (*WebAuthnCredentialResponse, *Errors, error)

RetrieveWebAuthnCredential Retrieves the WebAuthn credential for the given Id. 

string id The Id of the WebAuthn credential.

func (*FusionAuthClient) RetrieveWebAuthnCredentialWithContext 

func (c *FusionAuthClient) RetrieveWebAuthnCredentialWithContext(ctx context.Context, id string) (*WebAuthnCredentialResponse, *Errors, error)

RetrieveWebAuthnCredentialWithContext Retrieves the WebAuthn credential for the given Id. 

string id The Id of the WebAuthn credential.

func (*FusionAuthClient) RetrieveWebAuthnCredentialsForUser 

func (c *FusionAuthClient) RetrieveWebAuthnCredentialsForUser(userId string) (*WebAuthnCredentialResponse, *Errors, error)

RetrieveWebAuthnCredentialsForUser Retrieves all WebAuthn credentials for the given user. 

string userId The user's ID.

func (*FusionAuthClient) RetrieveWebAuthnCredentialsForUserWithContext 

func (c *FusionAuthClient) RetrieveWebAuthnCredentialsForUserWithContext(ctx context.Context, userId string) (*WebAuthnCredentialResponse, *Errors, error)

RetrieveWebAuthnCredentialsForUserWithContext Retrieves all WebAuthn credentials for the given user. 

string userId The user's ID.

func (*FusionAuthClient) RetrieveWebhook 

func (c *FusionAuthClient) RetrieveWebhook(webhookId string) (*WebhookResponse, error)

RetrieveWebhook Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks. 

string webhookId (Optional) The Id of the webhook.

func (*FusionAuthClient) RetrieveWebhookAttemptLog 

func (c *FusionAuthClient) RetrieveWebhookAttemptLog(webhookAttemptLogId string) (*WebhookAttemptLogResponse, *Errors, error)

RetrieveWebhookAttemptLog Retrieves a single webhook attempt log for the given Id. 

string webhookAttemptLogId The Id of the webhook attempt log to retrieve.

func (*FusionAuthClient) RetrieveWebhookAttemptLogWithContext 

func (c *FusionAuthClient) RetrieveWebhookAttemptLogWithContext(ctx context.Context, webhookAttemptLogId string) (*WebhookAttemptLogResponse, *Errors, error)

RetrieveWebhookAttemptLogWithContext Retrieves a single webhook attempt log for the given Id. 

string webhookAttemptLogId The Id of the webhook attempt log to retrieve.

func (*FusionAuthClient) RetrieveWebhookEventLog 

func (c *FusionAuthClient) RetrieveWebhookEventLog(webhookEventLogId string) (*WebhookEventLogResponse, *Errors, error)

RetrieveWebhookEventLog Retrieves a single webhook event log for the given Id. 

string webhookEventLogId The Id of the webhook event log to retrieve.

func (*FusionAuthClient) RetrieveWebhookEventLogWithContext 

func (c *FusionAuthClient) RetrieveWebhookEventLogWithContext(ctx context.Context, webhookEventLogId string) (*WebhookEventLogResponse, *Errors, error)

RetrieveWebhookEventLogWithContext Retrieves a single webhook event log for the given Id. 

string webhookEventLogId The Id of the webhook event log to retrieve.

func (*FusionAuthClient) RetrieveWebhookWithContext 

func (c *FusionAuthClient) RetrieveWebhookWithContext(ctx context.Context, webhookId string) (*WebhookResponse, error)

RetrieveWebhookWithContext Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks. 

string webhookId (Optional) The Id of the webhook.

func (*FusionAuthClient) RetrieveWebhooks 

func (c *FusionAuthClient) RetrieveWebhooks() (*WebhookResponse, error)

RetrieveWebhooks Retrieves all the webhooks.

func (*FusionAuthClient) RetrieveWebhooksWithContext 

func (c *FusionAuthClient) RetrieveWebhooksWithContext(ctx context.Context) (*WebhookResponse, error)

RetrieveWebhooksWithContext Retrieves all the webhooks.

func (*FusionAuthClient) RevokeRefreshToken 

func (c *FusionAuthClient) RevokeRefreshToken(token string, userId string, applicationId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshToken Revokes refresh tokens.

Usage examples:

  • Delete a single refresh token, pass in only the token. revokeRefreshToken(token)

  • Delete all refresh tokens for a user, pass in only the userId. revokeRefreshToken(null, userId)

  • Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId. revokeRefreshToken(null, userId, applicationId)

  • Delete all refresh tokens for an application revokeRefreshToken(null, null, applicationId)

Note: <code>null</code> may be handled differently depending upon the programming language.

See also: (method names may vary by language... but you'll figure it out)

  • revokeRefreshTokenById
  • revokeRefreshTokenByToken
  • revokeRefreshTokensByUserId
  • revokeRefreshTokensByApplicationId
  • revokeRefreshTokensByUserIdForApplication string token (Optional) The refresh token to delete. string userId (Optional) The user Id whose tokens to delete. string applicationId (Optional) The application Id of the tokens to delete.

func (*FusionAuthClient) RevokeRefreshTokenById 

func (c *FusionAuthClient) RevokeRefreshTokenById(tokenId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokenById Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT. 

string tokenId The unique Id of the token to delete.

func (*FusionAuthClient) RevokeRefreshTokenByIdWithContext 

func (c *FusionAuthClient) RevokeRefreshTokenByIdWithContext(ctx context.Context, tokenId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokenByIdWithContext Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT. 

string tokenId The unique Id of the token to delete.

func (*FusionAuthClient) RevokeRefreshTokenByToken 

func (c *FusionAuthClient) RevokeRefreshTokenByToken(token string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokenByToken Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so be careful with this API request. 

string token The refresh token to delete.

func (*FusionAuthClient) RevokeRefreshTokenByTokenWithContext 

func (c *FusionAuthClient) RevokeRefreshTokenByTokenWithContext(ctx context.Context, token string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokenByTokenWithContext Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so be careful with this API request. 

string token The refresh token to delete.

func (*FusionAuthClient) RevokeRefreshTokenWithContext 

func (c *FusionAuthClient) RevokeRefreshTokenWithContext(ctx context.Context, token string, userId string, applicationId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokenWithContext Revokes refresh tokens.

Usage examples:

  • Delete a single refresh token, pass in only the token. revokeRefreshToken(token)

  • Delete all refresh tokens for a user, pass in only the userId. revokeRefreshToken(null, userId)

  • Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId. revokeRefreshToken(null, userId, applicationId)

  • Delete all refresh tokens for an application revokeRefreshToken(null, null, applicationId)

Note: <code>null</code> may be handled differently depending upon the programming language.

See also: (method names may vary by language... but you'll figure it out)

  • revokeRefreshTokenById
  • revokeRefreshTokenByToken
  • revokeRefreshTokensByUserId
  • revokeRefreshTokensByApplicationId
  • revokeRefreshTokensByUserIdForApplication string token (Optional) The refresh token to delete. string userId (Optional) The user Id whose tokens to delete. string applicationId (Optional) The application Id of the tokens to delete.

func (*FusionAuthClient) RevokeRefreshTokensByApplicationId 

func (c *FusionAuthClient) RevokeRefreshTokensByApplicationId(applicationId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensByApplicationId Revoke all refresh tokens that belong to an application by applicationId. 

string applicationId The unique Id of the application that you want to delete all refresh tokens for.

func (*FusionAuthClient) RevokeRefreshTokensByApplicationIdWithContext 

func (c *FusionAuthClient) RevokeRefreshTokensByApplicationIdWithContext(ctx context.Context, applicationId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensByApplicationIdWithContext Revoke all refresh tokens that belong to an application by applicationId. 

string applicationId The unique Id of the application that you want to delete all refresh tokens for.

func (*FusionAuthClient) RevokeRefreshTokensByUserId 

func (c *FusionAuthClient) RevokeRefreshTokensByUserId(userId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensByUserId Revoke all refresh tokens that belong to a user by user Id. 

string userId The unique Id of the user that you want to delete all refresh tokens for.

func (*FusionAuthClient) RevokeRefreshTokensByUserIdForApplication 

func (c *FusionAuthClient) RevokeRefreshTokensByUserIdForApplication(userId string, applicationId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensByUserIdForApplication Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId. 

string userId The unique Id of the user that you want to delete all refresh tokens for.
string applicationId The unique Id of the application that you want to delete refresh tokens for.

func (*FusionAuthClient) RevokeRefreshTokensByUserIdForApplicationWithContext 

func (c *FusionAuthClient) RevokeRefreshTokensByUserIdForApplicationWithContext(ctx context.Context, userId string, applicationId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensByUserIdForApplicationWithContext Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId. 

string userId The unique Id of the user that you want to delete all refresh tokens for.
string applicationId The unique Id of the application that you want to delete refresh tokens for.

func (*FusionAuthClient) RevokeRefreshTokensByUserIdWithContext 

func (c *FusionAuthClient) RevokeRefreshTokensByUserIdWithContext(ctx context.Context, userId string) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensByUserIdWithContext Revoke all refresh tokens that belong to a user by user Id. 

string userId The unique Id of the user that you want to delete all refresh tokens for.

func (*FusionAuthClient) RevokeRefreshTokensWithRequest 

func (c *FusionAuthClient) RevokeRefreshTokensWithRequest(request RefreshTokenRevokeRequest) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensWithRequest Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information. 

RefreshTokenRevokeRequest request The request information used to revoke the refresh tokens.

func (*FusionAuthClient) RevokeRefreshTokensWithRequestWithContext 

func (c *FusionAuthClient) RevokeRefreshTokensWithRequestWithContext(ctx context.Context, request RefreshTokenRevokeRequest) (*BaseHTTPResponse, *Errors, error)

RevokeRefreshTokensWithRequestWithContext Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information. 

RefreshTokenRevokeRequest request The request information used to revoke the refresh tokens.

func (*FusionAuthClient) RevokeUserConsent 

func (c *FusionAuthClient) RevokeUserConsent(userConsentId string) (*BaseHTTPResponse, error)

RevokeUserConsent Revokes a single User consent by Id. 

string userConsentId The User Consent Id

func (*FusionAuthClient) RevokeUserConsentWithContext 

func (c *FusionAuthClient) RevokeUserConsentWithContext(ctx context.Context, userConsentId string) (*BaseHTTPResponse, error)

RevokeUserConsentWithContext Revokes a single User consent by Id. 

string userConsentId The User Consent Id

func (*FusionAuthClient) SearchApplications 

func (c *FusionAuthClient) SearchApplications(request ApplicationSearchRequest) (*ApplicationSearchResponse, *Errors, error)

SearchApplications Searches applications with the specified criteria and pagination. 

ApplicationSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchApplicationsWithContext 

func (c *FusionAuthClient) SearchApplicationsWithContext(ctx context.Context, request ApplicationSearchRequest) (*ApplicationSearchResponse, *Errors, error)

SearchApplicationsWithContext Searches applications with the specified criteria and pagination. 

ApplicationSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchAuditLogs 

func (c *FusionAuthClient) SearchAuditLogs(request AuditLogSearchRequest) (*AuditLogSearchResponse, *Errors, error)

SearchAuditLogs Searches the audit logs with the specified criteria and pagination. 

AuditLogSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchAuditLogsWithContext 

func (c *FusionAuthClient) SearchAuditLogsWithContext(ctx context.Context, request AuditLogSearchRequest) (*AuditLogSearchResponse, *Errors, error)

SearchAuditLogsWithContext Searches the audit logs with the specified criteria and pagination. 

AuditLogSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchConsents 

func (c *FusionAuthClient) SearchConsents(request ConsentSearchRequest) (*ConsentSearchResponse, *Errors, error)

SearchConsents Searches consents with the specified criteria and pagination. 

ConsentSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchConsentsWithContext 

func (c *FusionAuthClient) SearchConsentsWithContext(ctx context.Context, request ConsentSearchRequest) (*ConsentSearchResponse, *Errors, error)

SearchConsentsWithContext Searches consents with the specified criteria and pagination. 

ConsentSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEmailTemplates 

func (c *FusionAuthClient) SearchEmailTemplates(request EmailTemplateSearchRequest) (*EmailTemplateSearchResponse, *Errors, error)

SearchEmailTemplates Searches email templates with the specified criteria and pagination. 

EmailTemplateSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEmailTemplatesWithContext 

func (c *FusionAuthClient) SearchEmailTemplatesWithContext(ctx context.Context, request EmailTemplateSearchRequest) (*EmailTemplateSearchResponse, *Errors, error)

SearchEmailTemplatesWithContext Searches email templates with the specified criteria and pagination. 

EmailTemplateSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEntities 

func (c *FusionAuthClient) SearchEntities(request EntitySearchRequest) (*EntitySearchResponse, *Errors, error)

SearchEntities Searches entities with the specified criteria and pagination. 

EntitySearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEntitiesByIds 

func (c *FusionAuthClient) SearchEntitiesByIds(ids []string) (*EntitySearchResponse, *Errors, error)

SearchEntitiesByIds Retrieves the entities for the given ids. If any Id is invalid, it is ignored. 

[]string ids The entity ids to search for.

func (*FusionAuthClient) SearchEntitiesByIdsWithContext 

func (c *FusionAuthClient) SearchEntitiesByIdsWithContext(ctx context.Context, ids []string) (*EntitySearchResponse, *Errors, error)

SearchEntitiesByIdsWithContext Retrieves the entities for the given ids. If any Id is invalid, it is ignored. 

[]string ids The entity ids to search for.

func (*FusionAuthClient) SearchEntitiesWithContext 

func (c *FusionAuthClient) SearchEntitiesWithContext(ctx context.Context, request EntitySearchRequest) (*EntitySearchResponse, *Errors, error)

SearchEntitiesWithContext Searches entities with the specified criteria and pagination. 

EntitySearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEntityGrants 

func (c *FusionAuthClient) SearchEntityGrants(request EntityGrantSearchRequest) (*EntityGrantSearchResponse, *Errors, error)

SearchEntityGrants Searches Entity Grants with the specified criteria and pagination. 

EntityGrantSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEntityGrantsWithContext 

func (c *FusionAuthClient) SearchEntityGrantsWithContext(ctx context.Context, request EntityGrantSearchRequest) (*EntityGrantSearchResponse, *Errors, error)

SearchEntityGrantsWithContext Searches Entity Grants with the specified criteria and pagination. 

EntityGrantSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEntityTypes 

func (c *FusionAuthClient) SearchEntityTypes(request EntityTypeSearchRequest) (*EntityTypeSearchResponse, *Errors, error)

SearchEntityTypes Searches the entity types with the specified criteria and pagination. 

EntityTypeSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEntityTypesWithContext 

func (c *FusionAuthClient) SearchEntityTypesWithContext(ctx context.Context, request EntityTypeSearchRequest) (*EntityTypeSearchResponse, *Errors, error)

SearchEntityTypesWithContext Searches the entity types with the specified criteria and pagination. 

EntityTypeSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEventLogs 

func (c *FusionAuthClient) SearchEventLogs(request EventLogSearchRequest) (*EventLogSearchResponse, *Errors, error)

SearchEventLogs Searches the event logs with the specified criteria and pagination. 

EventLogSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchEventLogsWithContext 

func (c *FusionAuthClient) SearchEventLogsWithContext(ctx context.Context, request EventLogSearchRequest) (*EventLogSearchResponse, *Errors, error)

SearchEventLogsWithContext Searches the event logs with the specified criteria and pagination. 

EventLogSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchGroupMembers 

func (c *FusionAuthClient) SearchGroupMembers(request GroupMemberSearchRequest) (*GroupMemberSearchResponse, *Errors, error)

SearchGroupMembers Searches group members with the specified criteria and pagination. 

GroupMemberSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchGroupMembersWithContext 

func (c *FusionAuthClient) SearchGroupMembersWithContext(ctx context.Context, request GroupMemberSearchRequest) (*GroupMemberSearchResponse, *Errors, error)

SearchGroupMembersWithContext Searches group members with the specified criteria and pagination. 

GroupMemberSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchGroups 

func (c *FusionAuthClient) SearchGroups(request GroupSearchRequest) (*GroupSearchResponse, *Errors, error)

SearchGroups Searches groups with the specified criteria and pagination. 

GroupSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchGroupsWithContext 

func (c *FusionAuthClient) SearchGroupsWithContext(ctx context.Context, request GroupSearchRequest) (*GroupSearchResponse, *Errors, error)

SearchGroupsWithContext Searches groups with the specified criteria and pagination. 

GroupSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchIPAccessControlLists 

func (c *FusionAuthClient) SearchIPAccessControlLists(request IPAccessControlListSearchRequest) (*IPAccessControlListSearchResponse, *Errors, error)

SearchIPAccessControlLists Searches the IP Access Control Lists with the specified criteria and pagination. 

IPAccessControlListSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchIPAccessControlListsWithContext 

func (c *FusionAuthClient) SearchIPAccessControlListsWithContext(ctx context.Context, request IPAccessControlListSearchRequest) (*IPAccessControlListSearchResponse, *Errors, error)

SearchIPAccessControlListsWithContext Searches the IP Access Control Lists with the specified criteria and pagination. 

IPAccessControlListSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchIdentityProviders 

func (c *FusionAuthClient) SearchIdentityProviders(request IdentityProviderSearchRequest) (*IdentityProviderSearchResponse, *Errors, error)

SearchIdentityProviders Searches identity providers with the specified criteria and pagination. 

IdentityProviderSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchIdentityProvidersWithContext 

func (c *FusionAuthClient) SearchIdentityProvidersWithContext(ctx context.Context, request IdentityProviderSearchRequest) (*IdentityProviderSearchResponse, *Errors, error)

SearchIdentityProvidersWithContext Searches identity providers with the specified criteria and pagination. 

IdentityProviderSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchKeys 

func (c *FusionAuthClient) SearchKeys(request KeySearchRequest) (*KeySearchResponse, *Errors, error)

SearchKeys Searches keys with the specified criteria and pagination. 

KeySearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchKeysWithContext 

func (c *FusionAuthClient) SearchKeysWithContext(ctx context.Context, request KeySearchRequest) (*KeySearchResponse, *Errors, error)

SearchKeysWithContext Searches keys with the specified criteria and pagination. 

KeySearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchLambdas 

func (c *FusionAuthClient) SearchLambdas(request LambdaSearchRequest) (*LambdaSearchResponse, *Errors, error)

SearchLambdas Searches lambdas with the specified criteria and pagination. 

LambdaSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchLambdasWithContext 

func (c *FusionAuthClient) SearchLambdasWithContext(ctx context.Context, request LambdaSearchRequest) (*LambdaSearchResponse, *Errors, error)

SearchLambdasWithContext Searches lambdas with the specified criteria and pagination. 

LambdaSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchLoginRecords 

func (c *FusionAuthClient) SearchLoginRecords(request LoginRecordSearchRequest) (*LoginRecordSearchResponse, *Errors, error)

SearchLoginRecords Searches the login records with the specified criteria and pagination. 

LoginRecordSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchLoginRecordsWithContext 

func (c *FusionAuthClient) SearchLoginRecordsWithContext(ctx context.Context, request LoginRecordSearchRequest) (*LoginRecordSearchResponse, *Errors, error)

SearchLoginRecordsWithContext Searches the login records with the specified criteria and pagination. 

LoginRecordSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchTenants 

func (c *FusionAuthClient) SearchTenants(request TenantSearchRequest) (*TenantSearchResponse, *Errors, error)

SearchTenants Searches tenants with the specified criteria and pagination. 

TenantSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchTenantsWithContext 

func (c *FusionAuthClient) SearchTenantsWithContext(ctx context.Context, request TenantSearchRequest) (*TenantSearchResponse, *Errors, error)

SearchTenantsWithContext Searches tenants with the specified criteria and pagination. 

TenantSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchThemes 

func (c *FusionAuthClient) SearchThemes(request ThemeSearchRequest) (*ThemeSearchResponse, *Errors, error)

SearchThemes Searches themes with the specified criteria and pagination. 

ThemeSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchThemesWithContext 

func (c *FusionAuthClient) SearchThemesWithContext(ctx context.Context, request ThemeSearchRequest) (*ThemeSearchResponse, *Errors, error)

SearchThemesWithContext Searches themes with the specified criteria and pagination. 

ThemeSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchUserComments 

func (c *FusionAuthClient) SearchUserComments(request UserCommentSearchRequest) (*UserCommentSearchResponse, *Errors, error)

SearchUserComments Searches user comments with the specified criteria and pagination. 

UserCommentSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchUserCommentsWithContext 

func (c *FusionAuthClient) SearchUserCommentsWithContext(ctx context.Context, request UserCommentSearchRequest) (*UserCommentSearchResponse, *Errors, error)

SearchUserCommentsWithContext Searches user comments with the specified criteria and pagination. 

UserCommentSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchUsers deprecated 

func (c *FusionAuthClient) SearchUsers(ids []string) (*SearchResponse, *Errors, error)

SearchUsers Retrieves the users for the given ids. If any Id is invalid, it is ignored. 

[]string ids The user ids to search for.

Deprecated: This method has been renamed to SearchUsersByIds, use that method instead.

func (*FusionAuthClient) SearchUsersByIds 

func (c *FusionAuthClient) SearchUsersByIds(ids []string) (*SearchResponse, *Errors, error)

SearchUsersByIds Retrieves the users for the given ids. If any Id is invalid, it is ignored. 

[]string ids The user ids to search for.

func (*FusionAuthClient) SearchUsersByIdsWithContext 

func (c *FusionAuthClient) SearchUsersByIdsWithContext(ctx context.Context, ids []string) (*SearchResponse, *Errors, error)

SearchUsersByIdsWithContext Retrieves the users for the given ids. If any Id is invalid, it is ignored. 

[]string ids The user ids to search for.

func (*FusionAuthClient) SearchUsersByQuery 

func (c *FusionAuthClient) SearchUsersByQuery(request SearchRequest) (*SearchResponse, *Errors, error)

SearchUsersByQuery Retrieves the users for the given search criteria and pagination. 

SearchRequest request The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
and sortFields.

func (*FusionAuthClient) SearchUsersByQueryString deprecated 

func (c *FusionAuthClient) SearchUsersByQueryString(request SearchRequest) (*SearchResponse, *Errors, error)

SearchUsersByQueryString Retrieves the users for the given search criteria and pagination. 

SearchRequest request The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
and sortFields.

Deprecated: This method has been renamed to SearchUsersByQuery, use that method instead.

func (*FusionAuthClient) SearchUsersByQueryStringWithContext deprecated 

func (c *FusionAuthClient) SearchUsersByQueryStringWithContext(ctx context.Context, request SearchRequest) (*SearchResponse, *Errors, error)

SearchUsersByQueryStringWithContext Retrieves the users for the given search criteria and pagination. 

SearchRequest request The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
and sortFields.

Deprecated: This method has been renamed to SearchUsersByQueryWithContext, use that method instead.

func (*FusionAuthClient) SearchUsersByQueryWithContext 

func (c *FusionAuthClient) SearchUsersByQueryWithContext(ctx context.Context, request SearchRequest) (*SearchResponse, *Errors, error)

SearchUsersByQueryWithContext Retrieves the users for the given search criteria and pagination. 

SearchRequest request The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
and sortFields.

func (*FusionAuthClient) SearchUsersWithContext deprecated 

func (c *FusionAuthClient) SearchUsersWithContext(ctx context.Context, ids []string) (*SearchResponse, *Errors, error)

SearchUsersWithContext Retrieves the users for the given ids. If any Id is invalid, it is ignored. 

[]string ids The user ids to search for.

Deprecated: This method has been renamed to SearchUsersByIdsWithContext, use that method instead.

func (*FusionAuthClient) SearchWebhookEventLogs 

func (c *FusionAuthClient) SearchWebhookEventLogs(request WebhookEventLogSearchRequest) (*WebhookEventLogSearchResponse, *Errors, error)

SearchWebhookEventLogs Searches the webhook event logs with the specified criteria and pagination. 

WebhookEventLogSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchWebhookEventLogsWithContext 

func (c *FusionAuthClient) SearchWebhookEventLogsWithContext(ctx context.Context, request WebhookEventLogSearchRequest) (*WebhookEventLogSearchResponse, *Errors, error)

SearchWebhookEventLogsWithContext Searches the webhook event logs with the specified criteria and pagination. 

WebhookEventLogSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchWebhooks 

func (c *FusionAuthClient) SearchWebhooks(request WebhookSearchRequest) (*WebhookSearchResponse, *Errors, error)

SearchWebhooks Searches webhooks with the specified criteria and pagination. 

WebhookSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SearchWebhooksWithContext 

func (c *FusionAuthClient) SearchWebhooksWithContext(ctx context.Context, request WebhookSearchRequest) (*WebhookSearchResponse, *Errors, error)

SearchWebhooksWithContext Searches webhooks with the specified criteria and pagination. 

WebhookSearchRequest request The search criteria and pagination information.

func (*FusionAuthClient) SendEmail 

func (c *FusionAuthClient) SendEmail(emailTemplateId string, request SendRequest) (*SendResponse, *Errors, error)

SendEmail Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value pairs in the email template. 

string emailTemplateId The Id for the template.
SendRequest request The send email request that contains all the information used to send the email.

func (*FusionAuthClient) SendEmailWithContext 

func (c *FusionAuthClient) SendEmailWithContext(ctx context.Context, emailTemplateId string, request SendRequest) (*SendResponse, *Errors, error)

SendEmailWithContext Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value pairs in the email template. 

string emailTemplateId The Id for the template.
SendRequest request The send email request that contains all the information used to send the email.

func (*FusionAuthClient) SendFamilyRequestEmail 

func (c *FusionAuthClient) SendFamilyRequestEmail(request FamilyEmailRequest) (*BaseHTTPResponse, *Errors, error)

SendFamilyRequestEmail Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family. 

FamilyEmailRequest request The request object that contains the parent email.

func (*FusionAuthClient) SendFamilyRequestEmailWithContext 

func (c *FusionAuthClient) SendFamilyRequestEmailWithContext(ctx context.Context, request FamilyEmailRequest) (*BaseHTTPResponse, *Errors, error)

SendFamilyRequestEmailWithContext Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family. 

FamilyEmailRequest request The request object that contains the parent email.

func (*FusionAuthClient) SendPasswordlessCode 

func (c *FusionAuthClient) SendPasswordlessCode(request PasswordlessSendRequest) (*BaseHTTPResponse, *Errors, error)

SendPasswordlessCode Send a passwordless authentication code in an email to complete login. 

PasswordlessSendRequest request The passwordless send request that contains all the information used to send an email containing a code.

func (*FusionAuthClient) SendPasswordlessCodeWithContext 

func (c *FusionAuthClient) SendPasswordlessCodeWithContext(ctx context.Context, request PasswordlessSendRequest) (*BaseHTTPResponse, *Errors, error)

SendPasswordlessCodeWithContext Send a passwordless authentication code in an email to complete login. 

PasswordlessSendRequest request The passwordless send request that contains all the information used to send an email containing a code.

func (*FusionAuthClient) SendTwoFactorCode deprecated 

func (c *FusionAuthClient) SendTwoFactorCode(request TwoFactorSendRequest) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCode Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. 

TwoFactorSendRequest request The request object that contains all the information used to send the code.

Deprecated: This method has been renamed to SendTwoFactorCodeForEnableDisable, use that method instead.

func (*FusionAuthClient) SendTwoFactorCodeForEnableDisable 

func (c *FusionAuthClient) SendTwoFactorCodeForEnableDisable(request TwoFactorSendRequest) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeForEnableDisable Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. 

TwoFactorSendRequest request The request object that contains all the information used to send the code.

func (*FusionAuthClient) SendTwoFactorCodeForEnableDisableWithContext 

func (c *FusionAuthClient) SendTwoFactorCodeForEnableDisableWithContext(ctx context.Context, request TwoFactorSendRequest) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeForEnableDisableWithContext Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. 

TwoFactorSendRequest request The request object that contains all the information used to send the code.

func (*FusionAuthClient) SendTwoFactorCodeForLogin deprecated 

func (c *FusionAuthClient) SendTwoFactorCodeForLogin(twoFactorId string) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeForLogin Send a Two Factor authentication code to allow the completion of Two Factor authentication. 

string twoFactorId The Id returned by the Login API necessary to complete Two Factor authentication.

Deprecated: This method has been renamed to SendTwoFactorCodeForLoginUsingMethod, use that method instead.

func (*FusionAuthClient) SendTwoFactorCodeForLoginUsingMethod 

func (c *FusionAuthClient) SendTwoFactorCodeForLoginUsingMethod(twoFactorId string, request TwoFactorSendRequest) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeForLoginUsingMethod Send a Two Factor authentication code to allow the completion of Two Factor authentication. 

string twoFactorId The Id returned by the Login API necessary to complete Two Factor authentication.
TwoFactorSendRequest request The Two Factor send request that contains all the information used to send the Two Factor code to the user.

func (*FusionAuthClient) SendTwoFactorCodeForLoginUsingMethodWithContext 

func (c *FusionAuthClient) SendTwoFactorCodeForLoginUsingMethodWithContext(ctx context.Context, twoFactorId string, request TwoFactorSendRequest) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeForLoginUsingMethodWithContext Send a Two Factor authentication code to allow the completion of Two Factor authentication. 

string twoFactorId The Id returned by the Login API necessary to complete Two Factor authentication.
TwoFactorSendRequest request The Two Factor send request that contains all the information used to send the Two Factor code to the user.

func (*FusionAuthClient) SendTwoFactorCodeForLoginWithContext deprecated 

func (c *FusionAuthClient) SendTwoFactorCodeForLoginWithContext(ctx context.Context, twoFactorId string) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeForLoginWithContext Send a Two Factor authentication code to allow the completion of Two Factor authentication. 

string twoFactorId The Id returned by the Login API necessary to complete Two Factor authentication.

Deprecated: This method has been renamed to SendTwoFactorCodeForLoginUsingMethodWithContext, use that method instead.

func (*FusionAuthClient) SendTwoFactorCodeWithContext deprecated 

func (c *FusionAuthClient) SendTwoFactorCodeWithContext(ctx context.Context, request TwoFactorSendRequest) (*BaseHTTPResponse, *Errors, error)

SendTwoFactorCodeWithContext Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. 

TwoFactorSendRequest request The request object that contains all the information used to send the code.

Deprecated: This method has been renamed to SendTwoFactorCodeForEnableDisableWithContext, use that method instead.

func (*FusionAuthClient) SetTenantId 

func (c *FusionAuthClient) SetTenantId(tenantId string)

SetTenantId sets the tenantId on the client

func (*FusionAuthClient) Start 

func (c *FusionAuthClient) Start(responseRef interface{}, errorRef interface{}) *restClient

func (*FusionAuthClient) StartAnonymous 

func (c *FusionAuthClient) StartAnonymous(responseRef interface{}, errorRef interface{}) *restClient

func (*FusionAuthClient) StartIdentityProviderLogin 

func (c *FusionAuthClient) StartIdentityProviderLogin(request IdentityProviderStartLoginRequest) (*IdentityProviderStartLoginResponse, *Errors, error)

StartIdentityProviderLogin Begins a login request for a 3rd party login that requires user interaction such as HYPR. 

IdentityProviderStartLoginRequest request The third-party login request that contains information from the third-party login
providers that FusionAuth uses to reconcile the user's account.

func (*FusionAuthClient) StartIdentityProviderLoginWithContext 

func (c *FusionAuthClient) StartIdentityProviderLoginWithContext(ctx context.Context, request IdentityProviderStartLoginRequest) (*IdentityProviderStartLoginResponse, *Errors, error)

StartIdentityProviderLoginWithContext Begins a login request for a 3rd party login that requires user interaction such as HYPR. 

IdentityProviderStartLoginRequest request The third-party login request that contains information from the third-party login
providers that FusionAuth uses to reconcile the user's account.

func (*FusionAuthClient) StartPasswordlessLogin 

func (c *FusionAuthClient) StartPasswordlessLogin(request PasswordlessStartRequest) (*PasswordlessStartResponse, *Errors, error)

StartPasswordlessLogin Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code. 

PasswordlessStartRequest request The passwordless start request that contains all the information used to begin the passwordless login request.

func (*FusionAuthClient) StartPasswordlessLoginWithContext 

func (c *FusionAuthClient) StartPasswordlessLoginWithContext(ctx context.Context, request PasswordlessStartRequest) (*PasswordlessStartResponse, *Errors, error)

StartPasswordlessLoginWithContext Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code. 

PasswordlessStartRequest request The passwordless start request that contains all the information used to begin the passwordless login request.

func (*FusionAuthClient) StartTwoFactorLogin 

func (c *FusionAuthClient) StartTwoFactorLogin(request TwoFactorStartRequest) (*TwoFactorStartResponse, *Errors, error)

StartTwoFactorLogin Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code.

This API is intended to allow you to begin a Two-Factor login outside a normal login that originated from the Login API (/api/login). 

TwoFactorStartRequest request The Two-Factor start request that contains all the information used to begin the Two-Factor login request.

func (*FusionAuthClient) StartTwoFactorLoginWithContext 

func (c *FusionAuthClient) StartTwoFactorLoginWithContext(ctx context.Context, request TwoFactorStartRequest) (*TwoFactorStartResponse, *Errors, error)

StartTwoFactorLoginWithContext Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code.

This API is intended to allow you to begin a Two-Factor login outside a normal login that originated from the Login API (/api/login). 

TwoFactorStartRequest request The Two-Factor start request that contains all the information used to begin the Two-Factor login request.

func (*FusionAuthClient) StartWebAuthnLogin 

func (c *FusionAuthClient) StartWebAuthnLogin(request WebAuthnStartRequest) (*WebAuthnStartResponse, *Errors, error)

StartWebAuthnLogin Start a WebAuthn authentication ceremony by generating a new challenge for the user 

WebAuthnStartRequest request An object containing data necessary for starting the authentication ceremony

func (*FusionAuthClient) StartWebAuthnLoginWithContext 

func (c *FusionAuthClient) StartWebAuthnLoginWithContext(ctx context.Context, request WebAuthnStartRequest) (*WebAuthnStartResponse, *Errors, error)

StartWebAuthnLoginWithContext Start a WebAuthn authentication ceremony by generating a new challenge for the user 

WebAuthnStartRequest request An object containing data necessary for starting the authentication ceremony

func (*FusionAuthClient) StartWebAuthnRegistration 

func (c *FusionAuthClient) StartWebAuthnRegistration(request WebAuthnRegisterStartRequest) (*WebAuthnRegisterStartResponse, *Errors, error)

StartWebAuthnRegistration Start a WebAuthn registration ceremony by generating a new challenge for the user 

WebAuthnRegisterStartRequest request An object containing data necessary for starting the registration ceremony

func (*FusionAuthClient) StartWebAuthnRegistrationWithContext 

func (c *FusionAuthClient) StartWebAuthnRegistrationWithContext(ctx context.Context, request WebAuthnRegisterStartRequest) (*WebAuthnRegisterStartResponse, *Errors, error)

StartWebAuthnRegistrationWithContext Start a WebAuthn registration ceremony by generating a new challenge for the user 

WebAuthnRegisterStartRequest request An object containing data necessary for starting the registration ceremony

func (*FusionAuthClient) TwoFactorLogin 

func (c *FusionAuthClient) TwoFactorLogin(request TwoFactorLoginRequest) (*LoginResponse, *Errors, error)

TwoFactorLogin Complete login using a 2FA challenge 

TwoFactorLoginRequest request The login request that contains the user credentials used to log them in.

func (*FusionAuthClient) TwoFactorLoginWithContext 

func (c *FusionAuthClient) TwoFactorLoginWithContext(ctx context.Context, request TwoFactorLoginRequest) (*LoginResponse, *Errors, error)

TwoFactorLoginWithContext Complete login using a 2FA challenge 

TwoFactorLoginRequest request The login request that contains the user credentials used to log them in.

func (*FusionAuthClient) UpdateAPIKey 

func (c *FusionAuthClient) UpdateAPIKey(apiKeyId string, request APIKeyRequest) (*APIKeyResponse, *Errors, error)

UpdateAPIKey Updates an API key by given id 

string apiKeyId The Id of the API key to update.
APIKeyRequest request The request object that contains all the information used to create the API Key.

func (*FusionAuthClient) UpdateAPIKeyWithContext 

func (c *FusionAuthClient) UpdateAPIKeyWithContext(ctx context.Context, apiKeyId string, request APIKeyRequest) (*APIKeyResponse, *Errors, error)

UpdateAPIKeyWithContext Updates an API key by given id 

string apiKeyId The Id of the API key to update.
APIKeyRequest request The request object that contains all the information used to create the API Key.

func (*FusionAuthClient) UpdateApplication 

func (c *FusionAuthClient) UpdateApplication(applicationId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

UpdateApplication Updates the application with the given Id. 

string applicationId The Id of the application to update.
ApplicationRequest request The request that contains all the new application information.

func (*FusionAuthClient) UpdateApplicationRole 

func (c *FusionAuthClient) UpdateApplicationRole(applicationId string, roleId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

UpdateApplicationRole Updates the application role with the given Id for the application. 

string applicationId The Id of the application that the role belongs to.
string roleId The Id of the role to update.
ApplicationRequest request The request that contains all the new role information.

func (*FusionAuthClient) UpdateApplicationRoleWithContext 

func (c *FusionAuthClient) UpdateApplicationRoleWithContext(ctx context.Context, applicationId string, roleId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

UpdateApplicationRoleWithContext Updates the application role with the given Id for the application. 

string applicationId The Id of the application that the role belongs to.
string roleId The Id of the role to update.
ApplicationRequest request The request that contains all the new role information.

func (*FusionAuthClient) UpdateApplicationWithContext 

func (c *FusionAuthClient) UpdateApplicationWithContext(ctx context.Context, applicationId string, request ApplicationRequest) (*ApplicationResponse, *Errors, error)

UpdateApplicationWithContext Updates the application with the given Id. 

string applicationId The Id of the application to update.
ApplicationRequest request The request that contains all the new application information.

func (*FusionAuthClient) UpdateConnector 

func (c *FusionAuthClient) UpdateConnector(connectorId string, request ConnectorRequest) (*ConnectorResponse, *Errors, error)

UpdateConnector Updates the connector with the given Id. 

string connectorId The Id of the connector to update.
ConnectorRequest request The request object that contains all the new connector information.

func (*FusionAuthClient) UpdateConnectorWithContext 

func (c *FusionAuthClient) UpdateConnectorWithContext(ctx context.Context, connectorId string, request ConnectorRequest) (*ConnectorResponse, *Errors, error)

UpdateConnectorWithContext Updates the connector with the given Id. 

string connectorId The Id of the connector to update.
ConnectorRequest request The request object that contains all the new connector information.

func (*FusionAuthClient) UpdateConsent 

func (c *FusionAuthClient) UpdateConsent(consentId string, request ConsentRequest) (*ConsentResponse, *Errors, error)

UpdateConsent Updates the consent with the given Id. 

string consentId The Id of the consent to update.
ConsentRequest request The request that contains all the new consent information.

func (*FusionAuthClient) UpdateConsentWithContext 

func (c *FusionAuthClient) UpdateConsentWithContext(ctx context.Context, consentId string, request ConsentRequest) (*ConsentResponse, *Errors, error)

UpdateConsentWithContext Updates the consent with the given Id. 

string consentId The Id of the consent to update.
ConsentRequest request The request that contains all the new consent information.

func (*FusionAuthClient) UpdateEmailTemplate 

func (c *FusionAuthClient) UpdateEmailTemplate(emailTemplateId string, request EmailTemplateRequest) (*EmailTemplateResponse, *Errors, error)

UpdateEmailTemplate Updates the email template with the given Id. 

string emailTemplateId The Id of the email template to update.
EmailTemplateRequest request The request that contains all the new email template information.

func (*FusionAuthClient) UpdateEmailTemplateWithContext 

func (c *FusionAuthClient) UpdateEmailTemplateWithContext(ctx context.Context, emailTemplateId string, request EmailTemplateRequest) (*EmailTemplateResponse, *Errors, error)

UpdateEmailTemplateWithContext Updates the email template with the given Id. 

string emailTemplateId The Id of the email template to update.
EmailTemplateRequest request The request that contains all the new email template information.

func (*FusionAuthClient) UpdateEntity 

func (c *FusionAuthClient) UpdateEntity(entityId string, request EntityRequest) (*EntityResponse, *Errors, error)

UpdateEntity Updates the Entity with the given Id. 

string entityId The Id of the Entity to update.
EntityRequest request The request that contains all the new Entity information.

func (*FusionAuthClient) UpdateEntityType 

func (c *FusionAuthClient) UpdateEntityType(entityTypeId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

UpdateEntityType Updates the Entity Type with the given Id. 

string entityTypeId The Id of the Entity Type to update.
EntityTypeRequest request The request that contains all the new Entity Type information.

func (*FusionAuthClient) UpdateEntityTypePermission 

func (c *FusionAuthClient) UpdateEntityTypePermission(entityTypeId string, permissionId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

UpdateEntityTypePermission Updates the permission with the given Id for the entity type. 

string entityTypeId The Id of the entityType that the permission belongs to.
string permissionId The Id of the permission to update.
EntityTypeRequest request The request that contains all the new permission information.

func (*FusionAuthClient) UpdateEntityTypePermissionWithContext 

func (c *FusionAuthClient) UpdateEntityTypePermissionWithContext(ctx context.Context, entityTypeId string, permissionId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

UpdateEntityTypePermissionWithContext Updates the permission with the given Id for the entity type. 

string entityTypeId The Id of the entityType that the permission belongs to.
string permissionId The Id of the permission to update.
EntityTypeRequest request The request that contains all the new permission information.

func (*FusionAuthClient) UpdateEntityTypeWithContext 

func (c *FusionAuthClient) UpdateEntityTypeWithContext(ctx context.Context, entityTypeId string, request EntityTypeRequest) (*EntityTypeResponse, *Errors, error)

UpdateEntityTypeWithContext Updates the Entity Type with the given Id. 

string entityTypeId The Id of the Entity Type to update.
EntityTypeRequest request The request that contains all the new Entity Type information.

func (*FusionAuthClient) UpdateEntityWithContext 

func (c *FusionAuthClient) UpdateEntityWithContext(ctx context.Context, entityId string, request EntityRequest) (*EntityResponse, *Errors, error)

UpdateEntityWithContext Updates the Entity with the given Id. 

string entityId The Id of the Entity to update.
EntityRequest request The request that contains all the new Entity information.

func (*FusionAuthClient) UpdateFamily 

func (c *FusionAuthClient) UpdateFamily(familyId string, request FamilyRequest) (*FamilyResponse, *Errors, error)

UpdateFamily Updates a family with a given Id. 

string familyId The Id of the family to update.
FamilyRequest request The request object that contains all the new family information.

func (*FusionAuthClient) UpdateFamilyWithContext 

func (c *FusionAuthClient) UpdateFamilyWithContext(ctx context.Context, familyId string, request FamilyRequest) (*FamilyResponse, *Errors, error)

UpdateFamilyWithContext Updates a family with a given Id. 

string familyId The Id of the family to update.
FamilyRequest request The request object that contains all the new family information.

func (*FusionAuthClient) UpdateForm 

func (c *FusionAuthClient) UpdateForm(formId string, request FormRequest) (*FormResponse, *Errors, error)

UpdateForm Updates the form with the given Id. 

string formId The Id of the form to update.
FormRequest request The request object that contains all the new form information.

func (*FusionAuthClient) UpdateFormField 

func (c *FusionAuthClient) UpdateFormField(fieldId string, request FormFieldRequest) (*FormFieldResponse, *Errors, error)

UpdateFormField Updates the form field with the given Id. 

string fieldId The Id of the form field to update.
FormFieldRequest request The request object that contains all the new form field information.

func (*FusionAuthClient) UpdateFormFieldWithContext 

func (c *FusionAuthClient) UpdateFormFieldWithContext(ctx context.Context, fieldId string, request FormFieldRequest) (*FormFieldResponse, *Errors, error)

UpdateFormFieldWithContext Updates the form field with the given Id. 

string fieldId The Id of the form field to update.
FormFieldRequest request The request object that contains all the new form field information.

func (*FusionAuthClient) UpdateFormWithContext 

func (c *FusionAuthClient) UpdateFormWithContext(ctx context.Context, formId string, request FormRequest) (*FormResponse, *Errors, error)

UpdateFormWithContext Updates the form with the given Id. 

string formId The Id of the form to update.
FormRequest request The request object that contains all the new form information.

func (*FusionAuthClient) UpdateGroup 

func (c *FusionAuthClient) UpdateGroup(groupId string, request GroupRequest) (*GroupResponse, *Errors, error)

UpdateGroup Updates the group with the given Id. 

string groupId The Id of the group to update.
GroupRequest request The request that contains all the new group information.

func (*FusionAuthClient) UpdateGroupMembers 

func (c *FusionAuthClient) UpdateGroupMembers(request MemberRequest) (*MemberResponse, *Errors, error)

UpdateGroupMembers Creates a member in a group. 

MemberRequest request The request object that contains all the information used to create the group member(s).

func (*FusionAuthClient) UpdateGroupMembersWithContext 

func (c *FusionAuthClient) UpdateGroupMembersWithContext(ctx context.Context, request MemberRequest) (*MemberResponse, *Errors, error)

UpdateGroupMembersWithContext Creates a member in a group. 

MemberRequest request The request object that contains all the information used to create the group member(s).

func (*FusionAuthClient) UpdateGroupWithContext 

func (c *FusionAuthClient) UpdateGroupWithContext(ctx context.Context, groupId string, request GroupRequest) (*GroupResponse, *Errors, error)

UpdateGroupWithContext Updates the group with the given Id. 

string groupId The Id of the group to update.
GroupRequest request The request that contains all the new group information.

func (*FusionAuthClient) UpdateIPAccessControlList 

func (c *FusionAuthClient) UpdateIPAccessControlList(accessControlListId string, request IPAccessControlListRequest) (*IPAccessControlListResponse, *Errors, error)

UpdateIPAccessControlList Updates the IP Access Control List with the given Id. 

string accessControlListId The Id of the IP Access Control List to update.
IPAccessControlListRequest request The request that contains all the new IP Access Control List information.

func (*FusionAuthClient) UpdateIPAccessControlListWithContext 

func (c *FusionAuthClient) UpdateIPAccessControlListWithContext(ctx context.Context, accessControlListId string, request IPAccessControlListRequest) (*IPAccessControlListResponse, *Errors, error)

UpdateIPAccessControlListWithContext Updates the IP Access Control List with the given Id. 

string accessControlListId The Id of the IP Access Control List to update.
IPAccessControlListRequest request The request that contains all the new IP Access Control List information.

func (*FusionAuthClient) UpdateIntegrations 

func (c *FusionAuthClient) UpdateIntegrations(request IntegrationRequest) (*IntegrationResponse, *Errors, error)

UpdateIntegrations Updates the available integrations. 

IntegrationRequest request The request that contains all the new integration information.

func (*FusionAuthClient) UpdateIntegrationsWithContext 

func (c *FusionAuthClient) UpdateIntegrationsWithContext(ctx context.Context, request IntegrationRequest) (*IntegrationResponse, *Errors, error)

UpdateIntegrationsWithContext Updates the available integrations. 

IntegrationRequest request The request that contains all the new integration information.

func (*FusionAuthClient) UpdateKey 

func (c *FusionAuthClient) UpdateKey(keyId string, request KeyRequest) (*KeyResponse, *Errors, error)

UpdateKey Updates the key with the given Id. 

string keyId The Id of the key to update.
KeyRequest request The request that contains all the new key information.

func (*FusionAuthClient) UpdateKeyWithContext 

func (c *FusionAuthClient) UpdateKeyWithContext(ctx context.Context, keyId string, request KeyRequest) (*KeyResponse, *Errors, error)

UpdateKeyWithContext Updates the key with the given Id. 

string keyId The Id of the key to update.
KeyRequest request The request that contains all the new key information.

func (*FusionAuthClient) UpdateLambda 

func (c *FusionAuthClient) UpdateLambda(lambdaId string, request LambdaRequest) (*LambdaResponse, *Errors, error)

UpdateLambda Updates the lambda with the given Id. 

string lambdaId The Id of the lambda to update.
LambdaRequest request The request that contains all the new lambda information.

func (*FusionAuthClient) UpdateLambdaWithContext 

func (c *FusionAuthClient) UpdateLambdaWithContext(ctx context.Context, lambdaId string, request LambdaRequest) (*LambdaResponse, *Errors, error)

UpdateLambdaWithContext Updates the lambda with the given Id. 

string lambdaId The Id of the lambda to update.
LambdaRequest request The request that contains all the new lambda information.

func (*FusionAuthClient) UpdateMessageTemplate 

func (c *FusionAuthClient) UpdateMessageTemplate(messageTemplateId string, request MessageTemplateRequest) (*MessageTemplateResponse, *Errors, error)

UpdateMessageTemplate Updates the message template with the given Id. 

string messageTemplateId The Id of the message template to update.
MessageTemplateRequest request The request that contains all the new message template information.

func (*FusionAuthClient) UpdateMessageTemplateWithContext 

func (c *FusionAuthClient) UpdateMessageTemplateWithContext(ctx context.Context, messageTemplateId string, request MessageTemplateRequest) (*MessageTemplateResponse, *Errors, error)

UpdateMessageTemplateWithContext Updates the message template with the given Id. 

string messageTemplateId The Id of the message template to update.
MessageTemplateRequest request The request that contains all the new message template information.

func (*FusionAuthClient) UpdateMessenger 

func (c *FusionAuthClient) UpdateMessenger(messengerId string, request MessengerRequest) (*MessengerResponse, *Errors, error)

UpdateMessenger Updates the messenger with the given Id. 

string messengerId The Id of the messenger to update.
MessengerRequest request The request object that contains all the new messenger information.

func (*FusionAuthClient) UpdateMessengerWithContext 

func (c *FusionAuthClient) UpdateMessengerWithContext(ctx context.Context, messengerId string, request MessengerRequest) (*MessengerResponse, *Errors, error)

UpdateMessengerWithContext Updates the messenger with the given Id. 

string messengerId The Id of the messenger to update.
MessengerRequest request The request object that contains all the new messenger information.

func (*FusionAuthClient) UpdateOAuthScope 

func (c *FusionAuthClient) UpdateOAuthScope(applicationId string, scopeId string, request ApplicationOAuthScopeRequest) (*ApplicationOAuthScopeResponse, *Errors, error)

UpdateOAuthScope Updates the OAuth scope with the given Id for the application. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to update.
ApplicationOAuthScopeRequest request The request that contains all the new OAuth scope information.

func (*FusionAuthClient) UpdateOAuthScopeWithContext 

func (c *FusionAuthClient) UpdateOAuthScopeWithContext(ctx context.Context, applicationId string, scopeId string, request ApplicationOAuthScopeRequest) (*ApplicationOAuthScopeResponse, *Errors, error)

UpdateOAuthScopeWithContext Updates the OAuth scope with the given Id for the application. 

string applicationId The Id of the application that the OAuth scope belongs to.
string scopeId The Id of the OAuth scope to update.
ApplicationOAuthScopeRequest request The request that contains all the new OAuth scope information.

func (*FusionAuthClient) UpdateRegistration 

func (c *FusionAuthClient) UpdateRegistration(userId string, request RegistrationRequest) (*RegistrationResponse, *Errors, error)

UpdateRegistration Updates the registration for the user with the given Id and the application defined in the request. 

string userId The Id of the user whose registration is going to be updated.
RegistrationRequest request The request that contains all the new registration information.

func (*FusionAuthClient) UpdateRegistrationWithContext 

func (c *FusionAuthClient) UpdateRegistrationWithContext(ctx context.Context, userId string, request RegistrationRequest) (*RegistrationResponse, *Errors, error)

UpdateRegistrationWithContext Updates the registration for the user with the given Id and the application defined in the request. 

string userId The Id of the user whose registration is going to be updated.
RegistrationRequest request The request that contains all the new registration information.

func (*FusionAuthClient) UpdateSystemConfiguration 

func (c *FusionAuthClient) UpdateSystemConfiguration(request SystemConfigurationRequest) (*SystemConfigurationResponse, *Errors, error)

UpdateSystemConfiguration Updates the system configuration. 

SystemConfigurationRequest request The request that contains all the new system configuration information.

func (*FusionAuthClient) UpdateSystemConfigurationWithContext 

func (c *FusionAuthClient) UpdateSystemConfigurationWithContext(ctx context.Context, request SystemConfigurationRequest) (*SystemConfigurationResponse, *Errors, error)

UpdateSystemConfigurationWithContext Updates the system configuration. 

SystemConfigurationRequest request The request that contains all the new system configuration information.

func (*FusionAuthClient) UpdateTenant 

func (c *FusionAuthClient) UpdateTenant(tenantId string, request TenantRequest) (*TenantResponse, *Errors, error)

UpdateTenant Updates the tenant with the given Id. 

string tenantId The Id of the tenant to update.
TenantRequest request The request that contains all the new tenant information.

func (*FusionAuthClient) UpdateTenantWithContext 

func (c *FusionAuthClient) UpdateTenantWithContext(ctx context.Context, tenantId string, request TenantRequest) (*TenantResponse, *Errors, error)

UpdateTenantWithContext Updates the tenant with the given Id. 

string tenantId The Id of the tenant to update.
TenantRequest request The request that contains all the new tenant information.

func (*FusionAuthClient) UpdateTheme 

func (c *FusionAuthClient) UpdateTheme(themeId string, request ThemeRequest) (*ThemeResponse, *Errors, error)

UpdateTheme Updates the theme with the given Id. 

string themeId The Id of the theme to update.
ThemeRequest request The request that contains all the new theme information.

func (*FusionAuthClient) UpdateThemeWithContext 

func (c *FusionAuthClient) UpdateThemeWithContext(ctx context.Context, themeId string, request ThemeRequest) (*ThemeResponse, *Errors, error)

UpdateThemeWithContext Updates the theme with the given Id. 

string themeId The Id of the theme to update.
ThemeRequest request The request that contains all the new theme information.

func (*FusionAuthClient) UpdateUser 

func (c *FusionAuthClient) UpdateUser(userId string, request UserRequest) (*UserResponse, *Errors, error)

UpdateUser Updates the user with the given Id. 

string userId The Id of the user to update.
UserRequest request The request that contains all the new user information.

func (*FusionAuthClient) UpdateUserAction 

func (c *FusionAuthClient) UpdateUserAction(userActionId string, request UserActionRequest) (*UserActionResponse, *Errors, error)

UpdateUserAction Updates the user action with the given Id. 

string userActionId The Id of the user action to update.
UserActionRequest request The request that contains all the new user action information.

func (*FusionAuthClient) UpdateUserActionReason 

func (c *FusionAuthClient) UpdateUserActionReason(userActionReasonId string, request UserActionReasonRequest) (*UserActionReasonResponse, *Errors, error)

UpdateUserActionReason Updates the user action reason with the given Id. 

string userActionReasonId The Id of the user action reason to update.
UserActionReasonRequest request The request that contains all the new user action reason information.

func (*FusionAuthClient) UpdateUserActionReasonWithContext 

func (c *FusionAuthClient) UpdateUserActionReasonWithContext(ctx context.Context, userActionReasonId string, request UserActionReasonRequest) (*UserActionReasonResponse, *Errors, error)

UpdateUserActionReasonWithContext Updates the user action reason with the given Id. 

string userActionReasonId The Id of the user action reason to update.
UserActionReasonRequest request The request that contains all the new user action reason information.

func (*FusionAuthClient) UpdateUserActionWithContext 

func (c *FusionAuthClient) UpdateUserActionWithContext(ctx context.Context, userActionId string, request UserActionRequest) (*UserActionResponse, *Errors, error)

UpdateUserActionWithContext Updates the user action with the given Id. 

string userActionId The Id of the user action to update.
UserActionRequest request The request that contains all the new user action information.

func (*FusionAuthClient) UpdateUserConsent 

func (c *FusionAuthClient) UpdateUserConsent(userConsentId string, request UserConsentRequest) (*UserConsentResponse, *Errors, error)

UpdateUserConsent Updates a single User consent by Id. 

string userConsentId The User Consent Id
UserConsentRequest request The request that contains the user consent information.

func (*FusionAuthClient) UpdateUserConsentWithContext 

func (c *FusionAuthClient) UpdateUserConsentWithContext(ctx context.Context, userConsentId string, request UserConsentRequest) (*UserConsentResponse, *Errors, error)

UpdateUserConsentWithContext Updates a single User consent by Id. 

string userConsentId The User Consent Id
UserConsentRequest request The request that contains the user consent information.

func (*FusionAuthClient) UpdateUserWithContext 

func (c *FusionAuthClient) UpdateUserWithContext(ctx context.Context, userId string, request UserRequest) (*UserResponse, *Errors, error)

UpdateUserWithContext Updates the user with the given Id. 

string userId The Id of the user to update.
UserRequest request The request that contains all the new user information.

func (*FusionAuthClient) UpdateWebhook 

func (c *FusionAuthClient) UpdateWebhook(webhookId string, request WebhookRequest) (*WebhookResponse, *Errors, error)

UpdateWebhook Updates the webhook with the given Id. 

string webhookId The Id of the webhook to update.
WebhookRequest request The request that contains all the new webhook information.

func (*FusionAuthClient) UpdateWebhookWithContext 

func (c *FusionAuthClient) UpdateWebhookWithContext(ctx context.Context, webhookId string, request WebhookRequest) (*WebhookResponse, *Errors, error)

UpdateWebhookWithContext Updates the webhook with the given Id. 

string webhookId The Id of the webhook to update.
WebhookRequest request The request that contains all the new webhook information.

func (*FusionAuthClient) UpsertEntityGrant 

func (c *FusionAuthClient) UpsertEntityGrant(entityId string, request EntityGrantRequest) (*BaseHTTPResponse, *Errors, error)

UpsertEntityGrant Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity. 

string entityId The Id of the Entity that the User/Entity is being granted access to.
EntityGrantRequest request The request object that contains all the information used to create the Entity Grant.

func (*FusionAuthClient) UpsertEntityGrantWithContext 

func (c *FusionAuthClient) UpsertEntityGrantWithContext(ctx context.Context, entityId string, request EntityGrantRequest) (*BaseHTTPResponse, *Errors, error)

UpsertEntityGrantWithContext Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity. 

string entityId The Id of the Entity that the User/Entity is being granted access to.
EntityGrantRequest request The request object that contains all the information used to create the Entity Grant.

func (*FusionAuthClient) ValidateDevice 

func (c *FusionAuthClient) ValidateDevice(userCode string, clientId string) (*BaseHTTPResponse, error)

ValidateDevice Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant. If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant. 

string userCode The end-user verification code.
string clientId The client id.

func (*FusionAuthClient) ValidateDeviceWithContext 

func (c *FusionAuthClient) ValidateDeviceWithContext(ctx context.Context, userCode string, clientId string) (*BaseHTTPResponse, error)

ValidateDeviceWithContext Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant. If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant. 

string userCode The end-user verification code.
string clientId The client id.

func (*FusionAuthClient) ValidateJWT 

func (c *FusionAuthClient) ValidateJWT(encodedJWT string) (*ValidateResponse, error)

ValidateJWT Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired. <p> This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) ValidateJWTWithContext 

func (c *FusionAuthClient) ValidateJWTWithContext(ctx context.Context, encodedJWT string) (*ValidateResponse, error)

ValidateJWTWithContext Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired. <p> This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims. 

string encodedJWT The encoded JWT (access token).

func (*FusionAuthClient) VendJWT 

func (c *FusionAuthClient) VendJWT(request JWTVendRequest) (*JWTVendResponse, *Errors, error)

VendJWT It's a JWT vending machine!

Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form token that will contain what claims you provide. <p> The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller.

If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key. 

JWTVendRequest request The request that contains all the claims for this JWT.

func (*FusionAuthClient) VendJWTWithContext 

func (c *FusionAuthClient) VendJWTWithContext(ctx context.Context, request JWTVendRequest) (*JWTVendResponse, *Errors, error)

VendJWTWithContext It's a JWT vending machine!

Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form token that will contain what claims you provide. <p> The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller.

If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key. 

JWTVendRequest request The request that contains all the claims for this JWT.

func (*FusionAuthClient) VerifyEmail deprecated 

func (c *FusionAuthClient) VerifyEmail(verificationId string) (*BaseHTTPResponse, *Errors, error)

VerifyEmail Confirms a email verification. The Id given is usually from an email sent to the user. 

string verificationId The email verification Id sent to the user.

Deprecated: This method has been renamed to VerifyEmailAddress and changed to take a JSON request body, use that method instead.

func (*FusionAuthClient) VerifyEmailAddress 

func (c *FusionAuthClient) VerifyEmailAddress(request VerifyEmailRequest) (*BaseHTTPResponse, *Errors, error)

VerifyEmailAddress Confirms a user's email address.

The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's email address and mark the user's email address as verified. 

VerifyEmailRequest request The request that contains the verificationId and optional one-time use code paired with the verificationId.

func (*FusionAuthClient) VerifyEmailAddressByUserId 

func (c *FusionAuthClient) VerifyEmailAddressByUserId(request VerifyEmailRequest) (*BaseHTTPResponse, *Errors, error)

VerifyEmailAddressByUserId Administratively verify a user's email address. Use this method to bypass email verification for the user.

The request body will contain the userId to be verified. An API key is required when sending the userId in the request body. 

VerifyEmailRequest request The request that contains the userId to verify.

func (*FusionAuthClient) VerifyEmailAddressByUserIdWithContext 

func (c *FusionAuthClient) VerifyEmailAddressByUserIdWithContext(ctx context.Context, request VerifyEmailRequest) (*BaseHTTPResponse, *Errors, error)

VerifyEmailAddressByUserIdWithContext Administratively verify a user's email address. Use this method to bypass email verification for the user.

The request body will contain the userId to be verified. An API key is required when sending the userId in the request body. 

VerifyEmailRequest request The request that contains the userId to verify.

func (*FusionAuthClient) VerifyEmailAddressWithContext 

func (c *FusionAuthClient) VerifyEmailAddressWithContext(ctx context.Context, request VerifyEmailRequest) (*BaseHTTPResponse, *Errors, error)

VerifyEmailAddressWithContext Confirms a user's email address.

The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's email address and mark the user's email address as verified. 

VerifyEmailRequest request The request that contains the verificationId and optional one-time use code paired with the verificationId.

func (*FusionAuthClient) VerifyEmailWithContext deprecated 

func (c *FusionAuthClient) VerifyEmailWithContext(ctx context.Context, verificationId string) (*BaseHTTPResponse, *Errors, error)

VerifyEmailWithContext Confirms a email verification. The Id given is usually from an email sent to the user. 

string verificationId The email verification Id sent to the user.

Deprecated: This method has been renamed to VerifyEmailAddressWithContext and changed to take a JSON request body, use that method instead.

func (*FusionAuthClient) VerifyRegistration deprecated 

func (c *FusionAuthClient) VerifyRegistration(verificationId string) (*BaseHTTPResponse, *Errors, error)

VerifyRegistration Confirms an application registration. The Id given is usually from an email sent to the user. 

string verificationId The registration verification Id sent to the user.

Deprecated: This method has been renamed to VerifyUserRegistration and changed to take a JSON request body, use that method instead.

func (*FusionAuthClient) VerifyRegistrationWithContext deprecated 

func (c *FusionAuthClient) VerifyRegistrationWithContext(ctx context.Context, verificationId string) (*BaseHTTPResponse, *Errors, error)

VerifyRegistrationWithContext Confirms an application registration. The Id given is usually from an email sent to the user. 

string verificationId The registration verification Id sent to the user.

Deprecated: This method has been renamed to VerifyUserRegistrationWithContext and changed to take a JSON request body, use that method instead.

func (*FusionAuthClient) VerifyUserRegistration 

func (c *FusionAuthClient) VerifyUserRegistration(request VerifyRegistrationRequest) (*BaseHTTPResponse, *Errors, error)

VerifyUserRegistration Confirms a user's registration.

The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's registration and mark the user's registration as verified. 

VerifyRegistrationRequest request The request that contains the verificationId and optional one-time use code paired with the verificationId.

func (*FusionAuthClient) VerifyUserRegistrationWithContext 

func (c *FusionAuthClient) VerifyUserRegistrationWithContext(ctx context.Context, request VerifyRegistrationRequest) (*BaseHTTPResponse, *Errors, error)

VerifyUserRegistrationWithContext Confirms a user's registration.

The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's registration and mark the user's registration as verified. 

VerifyRegistrationRequest request The request that contains the verificationId and optional one-time use code paired with the verificationId.

type FusionAuthConnectorConfiguration 

type FusionAuthConnectorConfiguration struct {
	BaseConnectorConfiguration
}

*

  • Models the FusionAuth connector. *
  • @author Trevor Smith

type GenericConnectorConfiguration 

type GenericConnectorConfiguration struct {
	BaseConnectorConfiguration
	AuthenticationURL          string            `json:"authenticationURL,omitempty"`
	ConnectTimeout             int               `json:"connectTimeout,omitempty"`
	Headers                    map[string]string `json:"headers,omitempty"`
	HttpAuthenticationPassword string            `json:"httpAuthenticationPassword,omitempty"`
	HttpAuthenticationUsername string            `json:"httpAuthenticationUsername,omitempty"`
	ReadTimeout                int               `json:"readTimeout,omitempty"`
	SslCertificateKeyId        string            `json:"sslCertificateKeyId,omitempty"`
}

*

  • Models a generic connector. *
  • @author Trevor Smith

type GenericMessengerConfiguration 

type GenericMessengerConfiguration struct {
	BaseMessengerConfiguration
	ConnectTimeout             int               `json:"connectTimeout,omitempty"`
	Headers                    map[string]string `json:"headers,omitempty"`
	HttpAuthenticationPassword string            `json:"httpAuthenticationPassword,omitempty"`
	HttpAuthenticationUsername string            `json:"httpAuthenticationUsername,omitempty"`
	ReadTimeout                int               `json:"readTimeout,omitempty"`
	SslCertificate             string            `json:"sslCertificate,omitempty"`
	Url                        string            `json:"url,omitempty"`
}

*

  • @author Brett Guy

type GoogleApplicationConfiguration 

type GoogleApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ButtonText   string                           `json:"buttonText,omitempty"`
	ClientId     string                           `json:"client_id,omitempty"`
	ClientSecret string                           `json:"client_secret,omitempty"`
	LoginMethod  IdentityProviderLoginMethod      `json:"loginMethod,omitempty"`
	Properties   GoogleIdentityProviderProperties `json:"properties,omitempty"`
	Scope        string                           `json:"scope,omitempty"`
}

*

  • @author Daniel DeGroff

type GoogleIdentityProvider 

type GoogleIdentityProvider struct {
	BaseIdentityProvider
	ButtonText   string                           `json:"buttonText,omitempty"`
	ClientId     string                           `json:"client_id,omitempty"`
	ClientSecret string                           `json:"client_secret,omitempty"`
	LoginMethod  IdentityProviderLoginMethod      `json:"loginMethod,omitempty"`
	Properties   GoogleIdentityProviderProperties `json:"properties,omitempty"`
	Scope        string                           `json:"scope,omitempty"`
}

*

  • Google social login provider. *
  • @author Daniel DeGroff

type GoogleIdentityProviderProperties 

type GoogleIdentityProviderProperties struct {
	Api    string `json:"api,omitempty"`
	Button string `json:"button,omitempty"`
}

*

  • Google social login provider parameters. *
  • @author Daniel DeGroff

type GrantType 

type GrantType string

* 

const (
	GrantType_AuthorizationCode GrantType = "authorization_code"
	GrantType_Implicit          GrantType = "implicit"
	GrantType_Password          GrantType = "password"
	GrantType_ClientCredentials GrantType = "client_credentials"
	GrantType_RefreshToken      GrantType = "refresh_token"
	GrantType_Unknown           GrantType = "unknown"
	GrantType_DeviceCode        GrantType = "urn:ietf:params:oauth:grant-type:device_code"
)

func (GrantType) String 

func (e GrantType) String() string

type Group 

type Group 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"`
	Roles             map[string][]ApplicationRole `json:"roles,omitempty"`
	TenantId          string                       `json:"tenantId,omitempty"`
}

*

  • @author Tyler Scott

type GroupCreateCompleteEvent 

type GroupCreateCompleteEvent struct {
	BaseGroupEvent
}

*

  • Models the Group Created Event. *
  • @author Daniel DeGroff

type GroupCreateEvent 

type GroupCreateEvent struct {
	BaseGroupEvent
}

*

  • Models the Group Create Event. *
  • @author Daniel DeGroff

type GroupDeleteCompleteEvent 

type GroupDeleteCompleteEvent struct {
	BaseGroupEvent
}

*

  • Models the Group Create Complete Event. *
  • @author Daniel DeGroff

type GroupDeleteEvent 

type GroupDeleteEvent struct {
	BaseGroupEvent
}

*

  • Models the Group Delete Event. *
  • @author Daniel DeGroff

type GroupMember 

type GroupMember struct {
	Data          map[string]interface{} `json:"data,omitempty"`
	GroupId       string                 `json:"groupId,omitempty"`
	Id            string                 `json:"id,omitempty"`
	InsertInstant int64                  `json:"insertInstant,omitempty"`
	User          User                   `json:"user,omitempty"`
	UserId        string                 `json:"userId,omitempty"`
}

*

  • A User's membership into a Group *
  • @author Daniel DeGroff

type GroupMemberAddCompleteEvent 

type GroupMemberAddCompleteEvent struct {
	BaseGroupEvent
	Members []GroupMember `json:"members,omitempty"`
}

*

  • Models the Group Member Add Complete Event. *
  • @author Daniel DeGroff

type GroupMemberAddEvent 

type GroupMemberAddEvent struct {
	BaseGroupEvent
	Members []GroupMember `json:"members,omitempty"`
}

*

  • Models the Group Member Add Event. *
  • @author Daniel DeGroff

type GroupMemberRemoveCompleteEvent 

type GroupMemberRemoveCompleteEvent struct {
	BaseGroupEvent
	Members []GroupMember `json:"members,omitempty"`
}

*

  • Models the Group Member Remove Complete Event. *
  • @author Daniel DeGroff

type GroupMemberRemoveEvent 

type GroupMemberRemoveEvent struct {
	BaseGroupEvent
	Members []GroupMember `json:"members,omitempty"`
}

*

  • Models the Group Member Remove Event. *
  • @author Daniel DeGroff

type GroupMemberSearchCriteria 

type GroupMemberSearchCriteria struct {
	BaseSearchCriteria
	GroupId  string `json:"groupId,omitempty"`
	TenantId string `json:"tenantId,omitempty"`
	UserId   string `json:"userId,omitempty"`
}

*

  • Search criteria for Group Members *
  • @author Daniel DeGroff

type GroupMemberSearchRequest 

type GroupMemberSearchRequest struct {
	Search GroupMemberSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Group Members. *
  • @author Daniel DeGroff

type GroupMemberSearchResponse 

type GroupMemberSearchResponse struct {
	BaseHTTPResponse
	Members []GroupMember `json:"members,omitempty"`
	Total   int64         `json:"total,omitempty"`
}

*

  • Search response for Group Members *
  • @author Daniel DeGroff

func (*GroupMemberSearchResponse) SetStatus 

func (b *GroupMemberSearchResponse) SetStatus(status int)

type GroupMemberUpdateCompleteEvent 

type GroupMemberUpdateCompleteEvent struct {
	BaseGroupEvent
	Members []GroupMember `json:"members,omitempty"`
}

*

  • Models the Group Member Update Complete Event. *
  • @author Daniel DeGroff

type GroupMemberUpdateEvent 

type GroupMemberUpdateEvent struct {
	BaseGroupEvent
	Members []GroupMember `json:"members,omitempty"`
}

*

  • Models the Group Member Update Event. *
  • @author Daniel DeGroff

type GroupRequest 

type GroupRequest struct {
	Group   Group    `json:"group,omitempty"`
	RoleIds []string `json:"roleIds,omitempty"`
}

*

  • Group API request object. *
  • @author Daniel DeGroff

type GroupResponse 

type GroupResponse struct {
	BaseHTTPResponse
	Group  Group   `json:"group,omitempty"`
	Groups []Group `json:"groups,omitempty"`
}

*

  • Group API response object. *
  • @author Daniel DeGroff

func (*GroupResponse) SetStatus 

func (b *GroupResponse) SetStatus(status int)

type GroupSearchCriteria 

type GroupSearchCriteria struct {
	BaseSearchCriteria
	Name     string `json:"name,omitempty"`
	TenantId string `json:"tenantId,omitempty"`
}

*

  • Search criteria for Groups *
  • @author Daniel DeGroff

type GroupSearchRequest 

type GroupSearchRequest struct {
	Search GroupSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Groups. *
  • @author Daniel DeGroff

type GroupSearchResponse 

type GroupSearchResponse struct {
	BaseHTTPResponse
	Groups []Group `json:"groups,omitempty"`
	Total  int64   `json:"total,omitempty"`
}

*

  • Search response for Groups *
  • @author Daniel DeGroff

func (*GroupSearchResponse) SetStatus 

func (b *GroupSearchResponse) SetStatus(status int)

type GroupUpdateCompleteEvent 

type GroupUpdateCompleteEvent struct {
	BaseGroupEvent
	Original Group `json:"original,omitempty"`
}

*

  • Models the Group Update Complete Event. *
  • @author Daniel DeGroff

type GroupUpdateEvent 

type GroupUpdateEvent struct {
	BaseGroupEvent
	Original Group `json:"original,omitempty"`
}

*

  • Models the Group Update Event. *
  • @author Daniel DeGroff

type HTTPMethod 

type HTTPMethod string

*

  • @author Daniel DeGroff
const (
	HTTPMethod_GET     HTTPMethod = "GET"
	HTTPMethod_POST    HTTPMethod = "POST"
	HTTPMethod_PUT     HTTPMethod = "PUT"
	HTTPMethod_DELETE  HTTPMethod = "DELETE"
	HTTPMethod_HEAD    HTTPMethod = "HEAD"
	HTTPMethod_OPTIONS HTTPMethod = "OPTIONS"
	HTTPMethod_PATCH   HTTPMethod = "PATCH"
)

func (HTTPMethod) String 

func (e HTTPMethod) String() string

type HYPRApplicationConfiguration 

type HYPRApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	RelyingPartyApplicationId string `json:"relyingPartyApplicationId,omitempty"`
	RelyingPartyURL           string `json:"relyingPartyURL,omitempty"`
}

*

  • @author Daniel DeGroff

type HYPRIdentityProvider 

type HYPRIdentityProvider struct {
	BaseIdentityProvider
	RelyingPartyApplicationId string `json:"relyingPartyApplicationId,omitempty"`
	RelyingPartyURL           string `json:"relyingPartyURL,omitempty"`
}

*

  • @author Daniel DeGroff

type HistoryItem 

type HistoryItem struct {
	ActionerUserId string `json:"actionerUserId,omitempty"`
	Comment        string `json:"comment,omitempty"`
	CreateInstant  int64  `json:"createInstant,omitempty"`
	Expiry         int64  `json:"expiry,omitempty"`
}

type IPAccessControlEntry 

type IPAccessControlEntry struct {
	Action         IPAccessControlEntryAction `json:"action,omitempty"`
	EndIPAddress   string                     `json:"endIPAddress,omitempty"`
	StartIPAddress string                     `json:"startIPAddress,omitempty"`
}

*

  • @author Brett Guy

type IPAccessControlEntryAction 

type IPAccessControlEntryAction string

*

  • @author Brett Guy
const (
	IPAccessControlEntryAction_Allow IPAccessControlEntryAction = "Allow"
	IPAccessControlEntryAction_Block IPAccessControlEntryAction = "Block"
)

func (IPAccessControlEntryAction) String 

func (e IPAccessControlEntryAction) String() string

type IPAccessControlList 

type IPAccessControlList struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	Entries           []IPAccessControlEntry `json:"entries,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Name              string                 `json:"name,omitempty"`
}

*

  • @author Brett Guy

type IPAccessControlListRequest 

type IPAccessControlListRequest struct {
	IpAccessControlList IPAccessControlList `json:"ipAccessControlList,omitempty"`
}

*

  • @author Brett Guy

type IPAccessControlListResponse 

type IPAccessControlListResponse struct {
	BaseHTTPResponse
	IpAccessControlList  IPAccessControlList   `json:"ipAccessControlList,omitempty"`
	IpAccessControlLists []IPAccessControlList `json:"ipAccessControlLists,omitempty"`
}

*

  • @author Brett Guy

func (*IPAccessControlListResponse) SetStatus 

func (b *IPAccessControlListResponse) SetStatus(status int)

type IPAccessControlListSearchCriteria 

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

*

  • @author Brett Guy

type IPAccessControlListSearchRequest 

type IPAccessControlListSearchRequest struct {
	Search IPAccessControlListSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for IP ACLs . *
  • @author Brett Guy

type IPAccessControlListSearchResponse 

type IPAccessControlListSearchResponse struct {
	BaseHTTPResponse
	IpAccessControlLists []IPAccessControlList `json:"ipAccessControlLists,omitempty"`
	Total                int64                 `json:"total,omitempty"`
}

*

  • @author Brett Guy

func (*IPAccessControlListSearchResponse) SetStatus 

func (b *IPAccessControlListSearchResponse) SetStatus(status int)

type IdentityProviderDetails 

type IdentityProviderDetails struct {
	ApplicationIds []string                            `json:"applicationIds,omitempty"`
	Id             string                              `json:"id,omitempty"`
	IdpEndpoint    string                              `json:"idpEndpoint,omitempty"`
	Name           string                              `json:"name,omitempty"`
	Oauth2         IdentityProviderOauth2Configuration `json:"oauth2,omitempty"`
	Type           IdentityProviderType                `json:"type,omitempty"`
}

type IdentityProviderLimitUserLinkingPolicy 

type IdentityProviderLimitUserLinkingPolicy struct {
	Enableable
	MaximumLinks int `json:"maximumLinks,omitempty"`
}

*

  • @author Daniel DeGroff
type IdentityProviderLink struct {
	Data                   map[string]interface{} `json:"data,omitempty"`
	DisplayName            string                 `json:"displayName,omitempty"`
	IdentityProviderId     string                 `json:"identityProviderId,omitempty"`
	IdentityProviderName   string                 `json:"identityProviderName,omitempty"`
	IdentityProviderType   IdentityProviderType   `json:"identityProviderType,omitempty"`
	IdentityProviderUserId string                 `json:"identityProviderUserId,omitempty"`
	InsertInstant          int64                  `json:"insertInstant,omitempty"`
	LastLoginInstant       int64                  `json:"lastLoginInstant,omitempty"`
	TenantId               string                 `json:"tenantId,omitempty"`
	Token                  string                 `json:"token,omitempty"`
	UserId                 string                 `json:"userId,omitempty"`
}

*

  • @author Daniel DeGroff

type IdentityProviderLinkRequest 

type IdentityProviderLinkRequest struct {
	BaseEventRequest
	IdentityProviderLink IdentityProviderLink `json:"identityProviderLink,omitempty"`
	PendingIdPLinkId     string               `json:"pendingIdPLinkId,omitempty"`
}

*

  • @author Daniel DeGroff

type IdentityProviderLinkResponse 

type IdentityProviderLinkResponse struct {
	BaseHTTPResponse
	IdentityProviderLink  IdentityProviderLink   `json:"identityProviderLink,omitempty"`
	IdentityProviderLinks []IdentityProviderLink `json:"identityProviderLinks,omitempty"`
}

*

  • @author Daniel DeGroff

func (*IdentityProviderLinkResponse) SetStatus 

func (b *IdentityProviderLinkResponse) SetStatus(status int)

type IdentityProviderLinkingStrategy 

type IdentityProviderLinkingStrategy string

*

  • The IdP behavior when no user link has been made yet. *
  • @author Daniel DeGroff
const (
	IdentityProviderLinkingStrategy_CreatePendingLink             IdentityProviderLinkingStrategy = "CreatePendingLink"
	IdentityProviderLinkingStrategy_Disabled                      IdentityProviderLinkingStrategy = "Disabled"
	IdentityProviderLinkingStrategy_LinkAnonymously               IdentityProviderLinkingStrategy = "LinkAnonymously"
	IdentityProviderLinkingStrategy_LinkByEmail                   IdentityProviderLinkingStrategy = "LinkByEmail"
	IdentityProviderLinkingStrategy_LinkByEmailForExistingUser    IdentityProviderLinkingStrategy = "LinkByEmailForExistingUser"
	IdentityProviderLinkingStrategy_LinkByUsername                IdentityProviderLinkingStrategy = "LinkByUsername"
	IdentityProviderLinkingStrategy_LinkByUsernameForExistingUser IdentityProviderLinkingStrategy = "LinkByUsernameForExistingUser"
	IdentityProviderLinkingStrategy_Unsupported                   IdentityProviderLinkingStrategy = "Unsupported"
)

func (IdentityProviderLinkingStrategy) String 

func (e IdentityProviderLinkingStrategy) String() string

type IdentityProviderLoginMethod 

type IdentityProviderLoginMethod string

*

  • @author Brett Pontarelli
const (
	IdentityProviderLoginMethod_UsePopup            IdentityProviderLoginMethod = "UsePopup"
	IdentityProviderLoginMethod_UseRedirect         IdentityProviderLoginMethod = "UseRedirect"
	IdentityProviderLoginMethod_UseVendorJavaScript IdentityProviderLoginMethod = "UseVendorJavaScript"
)

func (IdentityProviderLoginMethod) String 

func (e IdentityProviderLoginMethod) String() string

type IdentityProviderLoginRequest 

type IdentityProviderLoginRequest struct {
	BaseLoginRequest
	Data               map[string]string `json:"data,omitempty"`
	EncodedJWT         string            `json:"encodedJWT,omitempty"`
	IdentityProviderId string            `json:"identityProviderId,omitempty"`
	NoLink             bool              `json:"noLink"`
}

*

  • Login API request object used for login to third-party systems (i.e. Login with Facebook). *
  • @author Brian Pontarelli

type IdentityProviderOauth2Configuration 

type IdentityProviderOauth2Configuration struct {
	AuthorizationEndpoint      string                     `json:"authorization_endpoint,omitempty"`
	ClientId                   string                     `json:"client_id,omitempty"`
	ClientSecret               string                     `json:"client_secret,omitempty"`
	ClientAuthenticationMethod ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
	EmailClaim                 string                     `json:"emailClaim,omitempty"`
	EmailVerifiedClaim         string                     `json:"emailVerifiedClaim,omitempty"`
	Issuer                     string                     `json:"issuer,omitempty"`
	Scope                      string                     `json:"scope,omitempty"`
	TokenEndpoint              string                     `json:"token_endpoint,omitempty"`
	UniqueIdClaim              string                     `json:"uniqueIdClaim,omitempty"`
	UserinfoEndpoint           string                     `json:"userinfo_endpoint,omitempty"`
	UsernameClaim              string                     `json:"usernameClaim,omitempty"`
}

*

  • @author Daniel DeGroff

type IdentityProviderPendingLinkResponse 

type IdentityProviderPendingLinkResponse struct {
	BaseHTTPResponse
	IdentityProviderTenantConfiguration IdentityProviderTenantConfiguration `json:"identityProviderTenantConfiguration,omitempty"`
	LinkCount                           int                                 `json:"linkCount,omitempty"`
	PendingIdPLink                      PendingIdPLink                      `json:"pendingIdPLink,omitempty"`
}

*

  • @author Daniel DeGroff

func (*IdentityProviderPendingLinkResponse) SetStatus 

func (b *IdentityProviderPendingLinkResponse) SetStatus(status int)

type IdentityProviderRequest 

type IdentityProviderRequest struct {
	IdentityProvider BaseIdentityProvider `json:"identityProvider,omitempty"`
}

*

  • @author Daniel DeGroff

type IdentityProviderResponse 

type IdentityProviderResponse struct {
	BaseHTTPResponse
	IdentityProvider  BaseIdentityProvider   `json:"identityProvider,omitempty"`
	IdentityProviders []BaseIdentityProvider `json:"identityProviders,omitempty"`
}

*

  • @author Daniel DeGroff

func (*IdentityProviderResponse) SetStatus 

func (b *IdentityProviderResponse) SetStatus(status int)

type IdentityProviderSearchCriteria 

type IdentityProviderSearchCriteria struct {
	BaseSearchCriteria
	ApplicationId string               `json:"applicationId,omitempty"`
	Name          string               `json:"name,omitempty"`
	Type          IdentityProviderType `json:"type,omitempty"`
}

*

  • Search criteria for Identity Providers. *
  • @author Spencer Witt

type IdentityProviderSearchRequest 

type IdentityProviderSearchRequest struct {
	Search IdentityProviderSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Identity Providers *
  • @author Spencer Witt

type IdentityProviderSearchResponse 

type IdentityProviderSearchResponse struct {
	BaseHTTPResponse
	IdentityProviders []BaseIdentityProvider `json:"identityProviders,omitempty"`
	Total             int64                  `json:"total,omitempty"`
}

*

  • Identity Provider response. *
  • @author Spencer Witt

func (*IdentityProviderSearchResponse) SetStatus 

func (b *IdentityProviderSearchResponse) SetStatus(status int)

type IdentityProviderStartLoginRequest 

type IdentityProviderStartLoginRequest struct {
	BaseLoginRequest
	Data               map[string]string      `json:"data,omitempty"`
	IdentityProviderId string                 `json:"identityProviderId,omitempty"`
	LoginId            string                 `json:"loginId,omitempty"`
	State              map[string]interface{} `json:"state,omitempty"`
}

*

  • @author Daniel DeGroff

type IdentityProviderStartLoginResponse 

type IdentityProviderStartLoginResponse struct {
	BaseHTTPResponse
	Code string `json:"code,omitempty"`
}

*

  • @author Daniel DeGroff

func (*IdentityProviderStartLoginResponse) SetStatus 

func (b *IdentityProviderStartLoginResponse) SetStatus(status int)

type IdentityProviderTenantConfiguration 

type IdentityProviderTenantConfiguration struct {
	Data               map[string]interface{}                 `json:"data,omitempty"`
	LimitUserLinkCount IdentityProviderLimitUserLinkingPolicy `json:"limitUserLinkCount,omitempty"`
}

*

  • @author Daniel DeGroff

type IdentityProviderType 

type IdentityProviderType string

*

  • @author Daniel DeGroff
const (
	IdentityProviderType_Apple              IdentityProviderType = "Apple"
	IdentityProviderType_EpicGames          IdentityProviderType = "EpicGames"
	IdentityProviderType_ExternalJWT        IdentityProviderType = "ExternalJWT"
	IdentityProviderType_Facebook           IdentityProviderType = "Facebook"
	IdentityProviderType_Google             IdentityProviderType = "Google"
	IdentityProviderType_HYPR               IdentityProviderType = "HYPR"
	IdentityProviderType_LinkedIn           IdentityProviderType = "LinkedIn"
	IdentityProviderType_Nintendo           IdentityProviderType = "Nintendo"
	IdentityProviderType_OpenIDConnect      IdentityProviderType = "OpenIDConnect"
	IdentityProviderType_SAMLv2             IdentityProviderType = "SAMLv2"
	IdentityProviderType_SAMLv2IdPInitiated IdentityProviderType = "SAMLv2IdPInitiated"
	IdentityProviderType_SonyPSN            IdentityProviderType = "SonyPSN"
	IdentityProviderType_Steam              IdentityProviderType = "Steam"
	IdentityProviderType_Twitch             IdentityProviderType = "Twitch"
	IdentityProviderType_Twitter            IdentityProviderType = "Twitter"
	IdentityProviderType_Xbox               IdentityProviderType = "Xbox"
)

func (IdentityProviderType) String 

func (e IdentityProviderType) String() string

type ImportRequest 

type ImportRequest struct {
	BaseEventRequest
	EncryptionScheme      string `json:"encryptionScheme,omitempty"`
	Factor                int    `json:"factor,omitempty"`
	Users                 []User `json:"users,omitempty"`
	ValidateDbConstraints bool   `json:"validateDbConstraints"`
}

*

  • Import request. *
  • @author Brian Pontarelli

type InstanceEvent 

type InstanceEvent struct {
	NonTransactionalEvent
}

*

  • A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks. *
  • @author Daniel DeGroff

type IntegrationRequest 

type IntegrationRequest struct {
	Integrations Integrations `json:"integrations,omitempty"`
}

*

  • The Integration Request *
  • @author Daniel DeGroff

type IntegrationResponse 

type IntegrationResponse struct {
	BaseHTTPResponse
	Integrations Integrations `json:"integrations,omitempty"`
}

*

  • The Integration Response *
  • @author Daniel DeGroff

func (*IntegrationResponse) SetStatus 

func (b *IntegrationResponse) SetStatus(status int)

type Integrations 

type Integrations struct {
	Cleanspeak CleanSpeakConfiguration `json:"cleanspeak,omitempty"`
	Kafka      KafkaConfiguration      `json:"kafka,omitempty"`
}

*

  • Available Integrations *
  • @author Daniel DeGroff

type IssueResponse 

type IssueResponse struct {
	BaseHTTPResponse
	RefreshToken string `json:"refreshToken,omitempty"`
	Token        string `json:"token,omitempty"`
}

*

  • @author Daniel DeGroff

func (*IssueResponse) SetStatus 

func (b *IssueResponse) SetStatus(status int)

type JSONWebKey 

type JSONWebKey struct {
	Alg      Algorithm              `json:"alg,omitempty"`
	Crv      string                 `json:"crv,omitempty"`
	D        string                 `json:"d,omitempty"`
	Dp       string                 `json:"dp,omitempty"`
	Dq       string                 `json:"dq,omitempty"`
	E        string                 `json:"e,omitempty"`
	Kid      string                 `json:"kid,omitempty"`
	Kty      KeyType                `json:"kty,omitempty"`
	N        string                 `json:"n,omitempty"`
	Other    map[string]interface{} `json:"other,omitempty"`
	P        string                 `json:"p,omitempty"`
	Q        string                 `json:"q,omitempty"`
	Qi       string                 `json:"qi,omitempty"`
	Use      string                 `json:"use,omitempty"`
	X        string                 `json:"x,omitempty"`
	X5c      []string               `json:"x5c,omitempty"`
	X5t      string                 `json:"x5t,omitempty"`
	X5t_S256 string                 `json:"x5t#S256,omitempty"`
	Y        string                 `json:"y,omitempty"`
}

*

type JSONWebKeyInfoProvider 

type JSONWebKeyInfoProvider struct {
}

*

  • Interface for any object that can provide JSON Web key Information.

type JWKSResponse 

type JWKSResponse struct {
	BaseHTTPResponse
	Keys []JSONWebKey `json:"keys,omitempty"`
}

*

  • @author Daniel DeGroff

func (*JWKSResponse) SetStatus 

func (b *JWKSResponse) SetStatus(status int)

type JWT 

type JWT struct {
	Aud         interface{}            `json:"aud,omitempty"`
	Exp         int64                  `json:"exp,omitempty"`
	Iat         int64                  `json:"iat,omitempty"`
	Iss         string                 `json:"iss,omitempty"`
	Jti         string                 `json:"jti,omitempty"`
	Nbf         int64                  `json:"nbf,omitempty"`
	OtherClaims map[string]interface{} `json:"otherClaims,omitempty"`
	Sub         string                 `json:"sub,omitempty"`
}

*

  • JSON Web Token (JWT) as defined by RFC 7519.
  • <pre>
  • From RFC 7519 Section 1. Introduction:
  • The suggested pronunciation of JWT is the same as the English word "jot".
  • </pre>
  • The JWT is not Thread-Safe and should not be re-used. *
  • @author Daniel DeGroff

type JWTConfiguration 

type JWTConfiguration struct {
	Enableable
	AccessTokenKeyId                       string                                 `json:"accessTokenKeyId,omitempty"`
	IdTokenKeyId                           string                                 `json:"idTokenKeyId,omitempty"`
	RefreshTokenExpirationPolicy           RefreshTokenExpirationPolicy           `json:"refreshTokenExpirationPolicy,omitempty"`
	RefreshTokenOneTimeUseConfiguration    RefreshTokenOneTimeUseConfiguration    `json:"refreshTokenOneTimeUseConfiguration,omitempty"`
	RefreshTokenRevocationPolicy           RefreshTokenRevocationPolicy           `json:"refreshTokenRevocationPolicy,omitempty"`
	RefreshTokenSlidingWindowConfiguration RefreshTokenSlidingWindowConfiguration `json:"refreshTokenSlidingWindowConfiguration,omitempty"`
	RefreshTokenTimeToLiveInMinutes        int                                    `json:"refreshTokenTimeToLiveInMinutes,omitempty"`
	RefreshTokenUsagePolicy                RefreshTokenUsagePolicy                `json:"refreshTokenUsagePolicy,omitempty"`
	TimeToLiveInSeconds                    int                                    `json:"timeToLiveInSeconds,omitempty"`
}

*

  • JWT Configuration. A JWT Configuration for an Application may not be active if it is using the global configuration, the configuration
  • may be <code>enabled = false</code>. *
  • @author Daniel DeGroff

type JWTPublicKeyUpdateEvent 

type JWTPublicKeyUpdateEvent struct {
	BaseEvent
	ApplicationIds []string `json:"applicationIds,omitempty"`
}

*

  • Models the JWT public key Refresh Token Revoke Event. This event might be for a single
  • token, a user or an entire application. *
  • @author Brian Pontarelli

type JWTRefreshEvent 

type JWTRefreshEvent struct {
	BaseEvent
	ApplicationId string `json:"applicationId,omitempty"`
	Original      string `json:"original,omitempty"`
	RefreshToken  string `json:"refreshToken,omitempty"`
	Token         string `json:"token,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • Models the JWT Refresh Event. This event will be fired when a JWT is "refreshed" (generated) using a Refresh Token. *
  • @author Daniel DeGroff

type JWTRefreshResponse 

type JWTRefreshResponse struct {
	BaseHTTPResponse
	RefreshToken   string `json:"refreshToken,omitempty"`
	RefreshTokenId string `json:"refreshTokenId,omitempty"`
	Token          string `json:"token,omitempty"`
}

*

  • API response for refreshing a JWT with a Refresh Token.
  • <p>
  • Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
  • string. *
  • @author Daniel DeGroff

func (*JWTRefreshResponse) SetStatus 

func (b *JWTRefreshResponse) SetStatus(status int)

type JWTRefreshTokenRevokeEvent 

type JWTRefreshTokenRevokeEvent struct {
	BaseEvent
	ApplicationId                  string         `json:"applicationId,omitempty"`
	ApplicationTimeToLiveInSeconds map[string]int `json:"applicationTimeToLiveInSeconds,omitempty"`
	RefreshToken                   RefreshToken   `json:"refreshToken,omitempty"`
	User                           User           `json:"user,omitempty"`
	UserId                         string         `json:"userId,omitempty"`
}

*

  • Models the Refresh Token Revoke Event. This event might be for a single token, a user
  • or an entire application. *
  • @author Brian Pontarelli

type JWTVendRequest 

type JWTVendRequest struct {
	Claims              map[string]interface{} `json:"claims,omitempty"`
	KeyId               string                 `json:"keyId,omitempty"`
	TimeToLiveInSeconds int                    `json:"timeToLiveInSeconds,omitempty"`
}

*

  • @author Daniel DeGroff

type JWTVendResponse 

type JWTVendResponse struct {
	BaseHTTPResponse
	Token string `json:"token,omitempty"`
}

*

  • @author Daniel DeGroff

func (*JWTVendResponse) SetStatus 

func (b *JWTVendResponse) SetStatus(status int)

type KafkaConfiguration 

type KafkaConfiguration struct {
	Enableable
	DefaultTopic string            `json:"defaultTopic,omitempty"`
	Producer     map[string]string `json:"producer,omitempty"`
}

*

  • @author Daniel DeGroff

type KafkaMessengerConfiguration 

type KafkaMessengerConfiguration struct {
	BaseMessengerConfiguration
	DefaultTopic string            `json:"defaultTopic,omitempty"`
	Producer     map[string]string `json:"producer,omitempty"`
}

*

  • @author Brett Guy

type Key 

type Key struct {
	Algorithm              KeyAlgorithm           `json:"algorithm,omitempty"`
	Certificate            string                 `json:"certificate,omitempty"`
	CertificateInformation CertificateInformation `json:"certificateInformation,omitempty"`
	ExpirationInstant      int64                  `json:"expirationInstant,omitempty"`
	HasPrivateKey          bool                   `json:"hasPrivateKey"`
	Id                     string                 `json:"id,omitempty"`
	InsertInstant          int64                  `json:"insertInstant,omitempty"`
	Issuer                 string                 `json:"issuer,omitempty"`
	Kid                    string                 `json:"kid,omitempty"`
	LastUpdateInstant      int64                  `json:"lastUpdateInstant,omitempty"`
	Length                 int                    `json:"length,omitempty"`
	Name                   string                 `json:"name,omitempty"`
	PrivateKey             string                 `json:"privateKey,omitempty"`
	PublicKey              string                 `json:"publicKey,omitempty"`
	Secret                 string                 `json:"secret,omitempty"`
	Type                   KeyType                `json:"type,omitempty"`
}

*

  • Domain for a public key, key pair or an HMAC secret. This is used by KeyMaster to manage keys for JWTs, SAML, etc. *
  • @author Brian Pontarelli

type KeyAlgorithm 

type KeyAlgorithm string
const (
	KeyAlgorithm_ES256 KeyAlgorithm = "ES256"
	KeyAlgorithm_ES384 KeyAlgorithm = "ES384"
	KeyAlgorithm_ES512 KeyAlgorithm = "ES512"
	KeyAlgorithm_HS256 KeyAlgorithm = "HS256"
	KeyAlgorithm_HS384 KeyAlgorithm = "HS384"
	KeyAlgorithm_HS512 KeyAlgorithm = "HS512"
	KeyAlgorithm_RS256 KeyAlgorithm = "RS256"
	KeyAlgorithm_RS384 KeyAlgorithm = "RS384"
	KeyAlgorithm_RS512 KeyAlgorithm = "RS512"
)

func (KeyAlgorithm) String 

func (e KeyAlgorithm) String() string

type KeyRequest 

type KeyRequest struct {
	Key Key `json:"key,omitempty"`
}

*

  • Key API request object. *
  • @author Daniel DeGroff

type KeyResponse 

type KeyResponse struct {
	BaseHTTPResponse
	Key  Key   `json:"key,omitempty"`
	Keys []Key `json:"keys,omitempty"`
}

*

  • Key API response object. *
  • @author Daniel DeGroff

func (*KeyResponse) SetStatus 

func (b *KeyResponse) SetStatus(status int)

type KeySearchCriteria 

type KeySearchCriteria struct {
	BaseSearchCriteria
	Algorithm KeyAlgorithm `json:"algorithm,omitempty"`
	Name      string       `json:"name,omitempty"`
	Type      KeyType      `json:"type,omitempty"`
}

*

  • Search criteria for Keys *
  • @author Spencer Witt

type KeySearchRequest 

type KeySearchRequest struct {
	Search KeySearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Keys *
  • @author Spencer Witt

type KeySearchResponse 

type KeySearchResponse struct {
	BaseHTTPResponse
	Keys  []Key `json:"keys,omitempty"`
	Total int64 `json:"total,omitempty"`
}

*

  • Key search response *
  • @author Spencer Witt

func (*KeySearchResponse) SetStatus 

func (b *KeySearchResponse) SetStatus(status int)

type KeyType 

type KeyType string
const (
	KeyType_EC   KeyType = "EC"
	KeyType_RSA  KeyType = "RSA"
	KeyType_HMAC KeyType = "HMAC"
)

func (KeyType) String 

func (e KeyType) String() string

type KeyUse 

type KeyUse string

*

  • The use type of a key. *
  • @author Daniel DeGroff
const (
	KeyUse_SignOnly      KeyUse = "SignOnly"
	KeyUse_SignAndVerify KeyUse = "SignAndVerify"
	KeyUse_VerifyOnly    KeyUse = "VerifyOnly"
)

func (KeyUse) String 

func (e KeyUse) String() string

type KickstartSuccessEvent 

type KickstartSuccessEvent struct {
	BaseEvent
	InstanceId string `json:"instanceId,omitempty"`
}

*

  • Event to indicate kickstart has been successfully completed. *
  • @author Daniel DeGroff

type LDAPConnectorConfiguration 

type LDAPConnectorConfiguration struct {
	BaseConnectorConfiguration
	AuthenticationURL     string                       `json:"authenticationURL,omitempty"`
	BaseStructure         string                       `json:"baseStructure,omitempty"`
	ConnectTimeout        int                          `json:"connectTimeout,omitempty"`
	IdentifyingAttribute  string                       `json:"identifyingAttribute,omitempty"`
	LambdaConfiguration   ConnectorLambdaConfiguration `json:"lambdaConfiguration,omitempty"`
	LoginIdAttribute      string                       `json:"loginIdAttribute,omitempty"`
	ReadTimeout           int                          `json:"readTimeout,omitempty"`
	RequestedAttributes   []string                     `json:"requestedAttributes,omitempty"`
	SecurityMethod        LDAPSecurityMethod           `json:"securityMethod,omitempty"`
	SystemAccountDN       string                       `json:"systemAccountDN,omitempty"`
	SystemAccountPassword string                       `json:"systemAccountPassword,omitempty"`
}

*

  • Models an LDAP connector. *
  • @author Trevor Smith

type LDAPSecurityMethod 

type LDAPSecurityMethod string
const (
	LDAPSecurityMethod_None     LDAPSecurityMethod = "None"
	LDAPSecurityMethod_LDAPS    LDAPSecurityMethod = "LDAPS"
	LDAPSecurityMethod_StartTLS LDAPSecurityMethod = "StartTLS"
)

func (LDAPSecurityMethod) String 

func (e LDAPSecurityMethod) String() string

type Lambda 

type Lambda struct {
	Body              string           `json:"body,omitempty"`
	Debug             bool             `json:"debug"`
	EngineType        LambdaEngineType `json:"engineType,omitempty"`
	Id                string           `json:"id,omitempty"`
	InsertInstant     int64            `json:"insertInstant,omitempty"`
	LastUpdateInstant int64            `json:"lastUpdateInstant,omitempty"`
	Name              string           `json:"name,omitempty"`
	Type              LambdaType       `json:"type,omitempty"`
}

*

  • A JavaScript lambda function that is executed during certain events inside FusionAuth. *
  • @author Brian Pontarelli

type LambdaConfiguration 

type LambdaConfiguration struct {
	AccessTokenPopulateId               string `json:"accessTokenPopulateId,omitempty"`
	IdTokenPopulateId                   string `json:"idTokenPopulateId,omitempty"`
	Samlv2PopulateId                    string `json:"samlv2PopulateId,omitempty"`
	SelfServiceRegistrationValidationId string `json:"selfServiceRegistrationValidationId,omitempty"`
	UserinfoPopulateId                  string `json:"userinfoPopulateId,omitempty"`
}

type LambdaEngineType 

type LambdaEngineType string

*

  • @author Daniel DeGroff
const (
	LambdaEngineType_GraalJS LambdaEngineType = "GraalJS"
	LambdaEngineType_Nashorn LambdaEngineType = "Nashorn"
)

func (LambdaEngineType) String 

func (e LambdaEngineType) String() string

type LambdaRequest 

type LambdaRequest struct {
	Lambda Lambda `json:"lambda,omitempty"`
}

*

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

type LambdaResponse 

type LambdaResponse struct {
	BaseHTTPResponse
	Lambda  Lambda   `json:"lambda,omitempty"`
	Lambdas []Lambda `json:"lambdas,omitempty"`
}

*

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

func (*LambdaResponse) SetStatus 

func (b *LambdaResponse) SetStatus(status int)

type LambdaSearchCriteria 

type LambdaSearchCriteria struct {
	BaseSearchCriteria
	Body string     `json:"body,omitempty"`
	Name string     `json:"name,omitempty"`
	Type LambdaType `json:"type,omitempty"`
}

*

  • Search criteria for Lambdas *
  • @author Mark Manes

type LambdaSearchRequest 

type LambdaSearchRequest struct {
	Search LambdaSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Lambdas *
  • @author Mark Manes

type LambdaSearchResponse 

type LambdaSearchResponse struct {
	BaseHTTPResponse
	Lambdas []Lambda `json:"lambdas,omitempty"`
	Total   int64    `json:"total,omitempty"`
}

*

  • Lambda search response *
  • @author Mark Manes

func (*LambdaSearchResponse) SetStatus 

func (b *LambdaSearchResponse) SetStatus(status int)

type LambdaType 

type LambdaType string

*

  • The types of lambdas that indicate how they are invoked by FusionAuth. *
  • @author Brian Pontarelli
const (
	LambdaType_JWTPopulate                       LambdaType = "JWTPopulate"
	LambdaType_OpenIDReconcile                   LambdaType = "OpenIDReconcile"
	LambdaType_SAMLv2Reconcile                   LambdaType = "SAMLv2Reconcile"
	LambdaType_SAMLv2Populate                    LambdaType = "SAMLv2Populate"
	LambdaType_AppleReconcile                    LambdaType = "AppleReconcile"
	LambdaType_ExternalJWTReconcile              LambdaType = "ExternalJWTReconcile"
	LambdaType_FacebookReconcile                 LambdaType = "FacebookReconcile"
	LambdaType_GoogleReconcile                   LambdaType = "GoogleReconcile"
	LambdaType_HYPRReconcile                     LambdaType = "HYPRReconcile"
	LambdaType_TwitterReconcile                  LambdaType = "TwitterReconcile"
	LambdaType_LDAPConnectorReconcile            LambdaType = "LDAPConnectorReconcile"
	LambdaType_LinkedInReconcile                 LambdaType = "LinkedInReconcile"
	LambdaType_EpicGamesReconcile                LambdaType = "EpicGamesReconcile"
	LambdaType_NintendoReconcile                 LambdaType = "NintendoReconcile"
	LambdaType_SonyPSNReconcile                  LambdaType = "SonyPSNReconcile"
	LambdaType_SteamReconcile                    LambdaType = "SteamReconcile"
	LambdaType_TwitchReconcile                   LambdaType = "TwitchReconcile"
	LambdaType_XboxReconcile                     LambdaType = "XboxReconcile"
	LambdaType_ClientCredentialsJWTPopulate      LambdaType = "ClientCredentialsJWTPopulate"
	LambdaType_SCIMServerGroupRequestConverter   LambdaType = "SCIMServerGroupRequestConverter"
	LambdaType_SCIMServerGroupResponseConverter  LambdaType = "SCIMServerGroupResponseConverter"
	LambdaType_SCIMServerUserRequestConverter    LambdaType = "SCIMServerUserRequestConverter"
	LambdaType_SCIMServerUserResponseConverter   LambdaType = "SCIMServerUserResponseConverter"
	LambdaType_SelfServiceRegistrationValidation LambdaType = "SelfServiceRegistrationValidation"
	LambdaType_UserInfoPopulate                  LambdaType = "UserInfoPopulate"
	LambdaType_LoginValidation                   LambdaType = "LoginValidation"
)

func (LambdaType) String 

func (e LambdaType) String() string

type LinkedHashMap 

type LinkedHashMap map[string]interface{}

type LinkedInApplicationConfiguration 

type LinkedInApplicationConfiguration 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 Daniel DeGroff

type LinkedInIdentityProvider 

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

*

  • @author Daniel DeGroff

type Location 

type Location struct {
	City          string  `json:"city,omitempty"`
	Country       string  `json:"country,omitempty"`
	DisplayString string  `json:"displayString,omitempty"`
	Latitude      float64 `json:"latitude,omitempty"`
	Longitude     float64 `json:"longitude,omitempty"`
	Region        string  `json:"region,omitempty"`
	Zipcode       string  `json:"zipcode,omitempty"`
}

*

  • Location information. Useful for IP addresses and other displayable data objects. *
  • @author Brian Pontarelli

type LogHistory 

type LogHistory struct {
	HistoryItems []HistoryItem `json:"historyItems,omitempty"`
}

*

  • A historical state of a user log event. Since events can be modified, this stores the historical state. *
  • @author Brian Pontarelli

type LoginConfiguration 

type LoginConfiguration struct {
	AllowTokenRefresh     bool `json:"allowTokenRefresh"`
	GenerateRefreshTokens bool `json:"generateRefreshTokens"`
	RequireAuthentication bool `json:"requireAuthentication"`
}

type LoginHintConfiguration 

type LoginHintConfiguration struct {
	Enableable
	ParameterName string `json:"parameterName,omitempty"`
}

*

  • @author Daniel DeGroff

type LoginIdType 

type LoginIdType string
const (
	LoginIdType_Email    LoginIdType = "email"
	LoginIdType_Username LoginIdType = "username"
)

func (LoginIdType) String 

func (e LoginIdType) String() string

type LoginPingRequest 

type LoginPingRequest struct {
	BaseLoginRequest
	UserId string `json:"userId,omitempty"`
}

*

  • Login Ping API request object. *
  • @author Daniel DeGroff

type LoginPreventedResponse 

type LoginPreventedResponse struct {
	BaseHTTPResponse
	ActionerUserId  string `json:"actionerUserId,omitempty"`
	ActionId        string `json:"actionId,omitempty"`
	Expiry          int64  `json:"expiry,omitempty"`
	LocalizedName   string `json:"localizedName,omitempty"`
	LocalizedOption string `json:"localizedOption,omitempty"`
	LocalizedReason string `json:"localizedReason,omitempty"`
	Name            string `json:"name,omitempty"`
	Option          string `json:"option,omitempty"`
	Reason          string `json:"reason,omitempty"`
	ReasonCode      string `json:"reasonCode,omitempty"`
}

*

  • The summary of the action that is preventing login to be returned on the login response. *
  • @author Daniel DeGroff

func (*LoginPreventedResponse) SetStatus 

func (b *LoginPreventedResponse) SetStatus(status int)

type LoginRecordConfiguration 

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

type LoginRecordExportRequest 

type LoginRecordExportRequest struct {
	BaseExportRequest
	Criteria LoginRecordSearchCriteria `json:"criteria,omitempty"`
}

*

  • @author Daniel DeGroff

type LoginRecordSearchCriteria 

type LoginRecordSearchCriteria struct {
	BaseSearchCriteria
	ApplicationId string `json:"applicationId,omitempty"`
	End           int64  `json:"end,omitempty"`
	Start         int64  `json:"start,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • @author Daniel DeGroff

type LoginRecordSearchRequest 

type LoginRecordSearchRequest struct {
	RetrieveTotal bool                      `json:"retrieveTotal"`
	Search        LoginRecordSearchCriteria `json:"search,omitempty"`
}

*

  • @author Daniel DeGroff

type LoginRecordSearchResponse 

type LoginRecordSearchResponse struct {
	BaseHTTPResponse
	Logins []DisplayableRawLogin `json:"logins,omitempty"`
	Total  int64                 `json:"total,omitempty"`
}

*

  • A raw login record response *
  • @author Daniel DeGroff

func (*LoginRecordSearchResponse) SetStatus 

func (b *LoginRecordSearchResponse) SetStatus(status int)

type LoginReportResponse 

type LoginReportResponse struct {
	BaseHTTPResponse
	HourlyCounts []Count `json:"hourlyCounts,omitempty"`
	Total        int64   `json:"total,omitempty"`
}

*

  • Response for the login report. *
  • @author Brian Pontarelli

func (*LoginReportResponse) SetStatus 

func (b *LoginReportResponse) SetStatus(status int)

type LoginRequest 

type LoginRequest struct {
	BaseLoginRequest
	LoginId          string `json:"loginId,omitempty"`
	OneTimePassword  string `json:"oneTimePassword,omitempty"`
	Password         string `json:"password,omitempty"`
	TwoFactorTrustId string `json:"twoFactorTrustId,omitempty"`
}

*

  • Login API request object. *
  • @author Seth Musselman

type LoginResponse 

type LoginResponse struct {
	BaseHTTPResponse
	Actions                    []LoginPreventedResponse `json:"actions,omitempty"`
	ChangePasswordId           string                   `json:"changePasswordId,omitempty"`
	ChangePasswordReason       ChangePasswordReason     `json:"changePasswordReason,omitempty"`
	ConfigurableMethods        []string                 `json:"configurableMethods,omitempty"`
	EmailVerificationId        string                   `json:"emailVerificationId,omitempty"`
	Methods                    []TwoFactorMethod        `json:"methods,omitempty"`
	PendingIdPLinkId           string                   `json:"pendingIdPLinkId,omitempty"`
	RefreshToken               string                   `json:"refreshToken,omitempty"`
	RefreshTokenId             string                   `json:"refreshTokenId,omitempty"`
	RegistrationVerificationId string                   `json:"registrationVerificationId,omitempty"`
	State                      map[string]interface{}   `json:"state,omitempty"`
	ThreatsDetected            []AuthenticationThreats  `json:"threatsDetected,omitempty"`
	Token                      string                   `json:"token,omitempty"`
	TokenExpirationInstant     int64                    `json:"tokenExpirationInstant,omitempty"`
	TrustToken                 string                   `json:"trustToken,omitempty"`
	TwoFactorId                string                   `json:"twoFactorId,omitempty"`
	TwoFactorTrustId           string                   `json:"twoFactorTrustId,omitempty"`
	User                       User                     `json:"user,omitempty"`
}

*

  • @author Brian Pontarelli

func (*LoginResponse) SetStatus 

func (b *LoginResponse) SetStatus(status int)

type LogoutBehavior 

type LogoutBehavior string

*

  • @author Matthew Altman
const (
	LogoutBehavior_RedirectOnly    LogoutBehavior = "RedirectOnly"
	LogoutBehavior_AllApplications LogoutBehavior = "AllApplications"
)

func (LogoutBehavior) String 

func (e LogoutBehavior) String() string

type LogoutRequest 

type LogoutRequest struct {
	BaseEventRequest
	Global       bool   `json:"global"`
	RefreshToken string `json:"refreshToken,omitempty"`
}

*

  • Request for the Logout API that can be used as an alternative to URL parameters. *
  • @author Brian Pontarelli

type LookupResponse 

type LookupResponse struct {
	BaseHTTPResponse
	IdentityProvider IdentityProviderDetails `json:"identityProvider,omitempty"`
}

*

  • @author Daniel DeGroff

func (*LookupResponse) SetStatus 

func (b *LookupResponse) SetStatus(status int)

type ManagedFields 

type ManagedFields struct {
}

*

  • This class contains the managed fields that are also put into the database during FusionAuth setup.
  • <p>
  • Internal Note: These fields are also declared in SQL in order to bootstrap the system. These need to stay in sync.
  • Any changes to these fields needs to also be reflected in mysql.sql and postgresql.sql *
  • @author Brian Pontarelli

type MaximumPasswordAge 

type MaximumPasswordAge struct {
	Enableable
	Days int `json:"days,omitempty"`
}

*

  • @author Daniel DeGroff

type MemberDeleteRequest 

type MemberDeleteRequest struct {
	MemberIds []string            `json:"memberIds,omitempty"`
	Members   map[string][]string `json:"members,omitempty"`
}

*

  • Group Member Delete Request *
  • @author Daniel DeGroff

type MemberRequest 

type MemberRequest struct {
	Members map[string][]GroupMember `json:"members,omitempty"`
}

*

  • Group Member Request *
  • @author Daniel DeGroff

type MemberResponse 

type MemberResponse struct {
	BaseHTTPResponse
	Members map[string][]GroupMember `json:"members,omitempty"`
}

*

  • Group Member Response *
  • @author Daniel DeGroff

func (*MemberResponse) SetStatus 

func (b *MemberResponse) SetStatus(status int)

type Message 

type Message struct {
}

*

  • @author Mikey Sleevi

type MessageTemplate 

type MessageTemplate 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"`
	Type              MessageType            `json:"type,omitempty"`
}

*

  • Stores an message template used to distribute messages; *
  • @author Michael Sleevi

type MessageTemplateRequest 

type MessageTemplateRequest struct {
	MessageTemplate MessageTemplate `json:"messageTemplate,omitempty"`
}

*

  • A Message Template Request to the API *
  • @author Michael Sleevi

type MessageTemplateResponse 

type MessageTemplateResponse struct {
	BaseHTTPResponse
	MessageTemplate  MessageTemplate   `json:"messageTemplate,omitempty"`
	MessageTemplates []MessageTemplate `json:"messageTemplates,omitempty"`
}

*

  • @author Michael Sleevi

func (*MessageTemplateResponse) SetStatus 

func (b *MessageTemplateResponse) SetStatus(status int)

type MessageType 

type MessageType string

*

  • @author Mikey Sleevi
const (
	MessageType_SMS MessageType = "SMS"
)

func (MessageType) String 

func (e MessageType) String() string

type MessengerRequest 

type MessengerRequest struct {
	Messenger BaseMessengerConfiguration `json:"messenger,omitempty"`
}

*

  • @author Brett Guy

type MessengerResponse 

type MessengerResponse struct {
	BaseHTTPResponse
	Messenger  BaseMessengerConfiguration   `json:"messenger,omitempty"`
	Messengers []BaseMessengerConfiguration `json:"messengers,omitempty"`
}

*

  • @author Brett Guy

func (*MessengerResponse) SetStatus 

func (b *MessengerResponse) SetStatus(status int)

type MessengerTransport 

type MessengerTransport struct {
}

*

  • @author Daniel DeGroff

type MessengerType 

type MessengerType string

*

  • @author Brett Guy
const (
	MessengerType_Generic MessengerType = "Generic"
	MessengerType_Kafka   MessengerType = "Kafka"
	MessengerType_Twilio  MessengerType = "Twilio"
)

func (MessengerType) String 

func (e MessengerType) String() string

type MetaData 

type MetaData struct {
	Data   map[string]interface{} `json:"data,omitempty"`
	Device DeviceInfo             `json:"device,omitempty"`
	Scopes []string               `json:"scopes,omitempty"`
}

type MinimumPasswordAge 

type MinimumPasswordAge struct {
	Enableable
	Seconds int `json:"seconds,omitempty"`
}

*

  • @author Daniel DeGroff

type MonthlyActiveUserReportResponse 

type MonthlyActiveUserReportResponse struct {
	BaseHTTPResponse
	MonthlyActiveUsers []Count `json:"monthlyActiveUsers,omitempty"`
	Total              int64   `json:"total,omitempty"`
}

*

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

func (*MonthlyActiveUserReportResponse) SetStatus 

func (b *MonthlyActiveUserReportResponse) SetStatus(status int)

type MultiFactorAuthenticatorMethod 

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

type MultiFactorEmailMethod 

type MultiFactorEmailMethod struct {
	Enableable
	TemplateId string `json:"templateId,omitempty"`
}

type MultiFactorEmailTemplate 

type MultiFactorEmailTemplate struct {
	TemplateId string `json:"templateId,omitempty"`
}

type MultiFactorLoginPolicy 

type MultiFactorLoginPolicy string

*

  • @author Daniel DeGroff
const (
	MultiFactorLoginPolicy_Disabled MultiFactorLoginPolicy = "Disabled"
	MultiFactorLoginPolicy_Enabled  MultiFactorLoginPolicy = "Enabled"
	MultiFactorLoginPolicy_Required MultiFactorLoginPolicy = "Required"
)

func (MultiFactorLoginPolicy) String 

func (e MultiFactorLoginPolicy) String() string

type MultiFactorSMSMethod 

type MultiFactorSMSMethod struct {
	Enableable
	MessengerId string `json:"messengerId,omitempty"`
	TemplateId  string `json:"templateId,omitempty"`
}

type MultiFactorSMSTemplate 

type MultiFactorSMSTemplate struct {
	TemplateId string `json:"templateId,omitempty"`
}

type NintendoApplicationConfiguration 

type NintendoApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ButtonText    string `json:"buttonText,omitempty"`
	ClientId      string `json:"client_id,omitempty"`
	ClientSecret  string `json:"client_secret,omitempty"`
	EmailClaim    string `json:"emailClaim,omitempty"`
	Scope         string `json:"scope,omitempty"`
	UniqueIdClaim string `json:"uniqueIdClaim,omitempty"`
	UsernameClaim string `json:"usernameClaim,omitempty"`
}

*

  • @author Brett Pontarelli

type NintendoIdentityProvider 

type NintendoIdentityProvider struct {
	BaseIdentityProvider
	ButtonText    string `json:"buttonText,omitempty"`
	ClientId      string `json:"client_id,omitempty"`
	ClientSecret  string `json:"client_secret,omitempty"`
	EmailClaim    string `json:"emailClaim,omitempty"`
	Scope         string `json:"scope,omitempty"`
	UniqueIdClaim string `json:"uniqueIdClaim,omitempty"`
	UsernameClaim string `json:"usernameClaim,omitempty"`
}

*

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

type NonTransactionalEvent 

type NonTransactionalEvent struct {
}

*

  • A marker interface indicating this event cannot be made transactional. *
  • @author Daniel DeGroff

type OAuth2Configuration 

type OAuth2Configuration struct {
	AuthorizedOriginURLs          []string                            `json:"authorizedOriginURLs,omitempty"`
	AuthorizedRedirectURLs        []string                            `json:"authorizedRedirectURLs,omitempty"`
	AuthorizedURLValidationPolicy Oauth2AuthorizedURLValidationPolicy `json:"authorizedURLValidationPolicy,omitempty"`
	ClientAuthenticationPolicy    ClientAuthenticationPolicy          `json:"clientAuthenticationPolicy,omitempty"`
	ClientId                      string                              `json:"clientId,omitempty"`
	ClientSecret                  string                              `json:"clientSecret,omitempty"`
	ConsentMode                   OAuthScopeConsentMode               `json:"consentMode,omitempty"`
	Debug                         bool                                `json:"debug"`
	DeviceVerificationURL         string                              `json:"deviceVerificationURL,omitempty"`
	EnabledGrants                 []GrantType                         `json:"enabledGrants,omitempty"`
	GenerateRefreshTokens         bool                                `json:"generateRefreshTokens"`
	LogoutBehavior                LogoutBehavior                      `json:"logoutBehavior,omitempty"`
	LogoutURL                     string                              `json:"logoutURL,omitempty"`
	ProofKeyForCodeExchangePolicy ProofKeyForCodeExchangePolicy       `json:"proofKeyForCodeExchangePolicy,omitempty"`
	ProvidedScopePolicy           ProvidedScopePolicy                 `json:"providedScopePolicy,omitempty"`
	Relationship                  OAuthApplicationRelationship        `json:"relationship,omitempty"`
	RequireClientAuthentication   bool                                `json:"requireClientAuthentication"`
	RequireRegistration           bool                                `json:"requireRegistration"`
	ScopeHandlingPolicy           OAuthScopeHandlingPolicy            `json:"scopeHandlingPolicy,omitempty"`
	UnknownScopePolicy            UnknownScopePolicy                  `json:"unknownScopePolicy,omitempty"`
}

*

  • @author Daniel DeGroff

type OAuthApplicationRelationship 

type OAuthApplicationRelationship string

*

  • The application's relationship to the authorization server. First-party applications will be granted implicit permission for requested scopes.
  • Third-party applications will use the {@link OAuthScopeConsentMode} policy. *
  • @author Spencer Witt
const (
	OAuthApplicationRelationship_FirstParty OAuthApplicationRelationship = "FirstParty"
	OAuthApplicationRelationship_ThirdParty OAuthApplicationRelationship = "ThirdParty"
)

func (OAuthApplicationRelationship) String 

func (e OAuthApplicationRelationship) String() string

type OAuthConfigurationResponse 

type OAuthConfigurationResponse struct {
	BaseHTTPResponse
	HttpSessionMaxInactiveInterval int                 `json:"httpSessionMaxInactiveInterval,omitempty"`
	LogoutURL                      string              `json:"logoutURL,omitempty"`
	OauthConfiguration             OAuth2Configuration `json:"oauthConfiguration,omitempty"`
}

*

  • @author Daniel DeGroff

func (*OAuthConfigurationResponse) SetStatus 

func (b *OAuthConfigurationResponse) SetStatus(status int)

type OAuthError 

type OAuthError struct {
	ChangePasswordId string            `json:"change_password_id,omitempty"`
	Error            OAuthErrorType    `json:"error,omitempty"`
	ErrorDescription string            `json:"error_description,omitempty"`
	ErrorReason      OAuthErrorReason  `json:"error_reason,omitempty"`
	ErrorUri         string            `json:"error_uri,omitempty"`
	TwoFactorId      string            `json:"two_factor_id,omitempty"`
	TwoFactorMethods []TwoFactorMethod `json:"two_factor_methods,omitempty"`
}

*

  • @author Daniel DeGroff

type OAuthErrorReason 

type OAuthErrorReason string
const (
	OAuthErrorReason_AuthCodeNotFound                    OAuthErrorReason = "auth_code_not_found"
	OAuthErrorReason_AccessTokenMalformed                OAuthErrorReason = "access_token_malformed"
	OAuthErrorReason_AccessTokenExpired                  OAuthErrorReason = "access_token_expired"
	OAuthErrorReason_AccessTokenUnavailableForProcessing OAuthErrorReason = "access_token_unavailable_for_processing"
	OAuthErrorReason_AccessTokenFailedProcessing         OAuthErrorReason = "access_token_failed_processing"
	OAuthErrorReason_AccessTokenInvalid                  OAuthErrorReason = "access_token_invalid"
	OAuthErrorReason_AccessTokenRequired                 OAuthErrorReason = "access_token_required"
	OAuthErrorReason_RefreshTokenNotFound                OAuthErrorReason = "refresh_token_not_found"
	OAuthErrorReason_RefreshTokenTypeNotSupported        OAuthErrorReason = "refresh_token_type_not_supported"
	OAuthErrorReason_InvalidClientId                     OAuthErrorReason = "invalid_client_id"
	OAuthErrorReason_InvalidUserCredentials              OAuthErrorReason = "invalid_user_credentials"
	OAuthErrorReason_InvalidGrantType                    OAuthErrorReason = "invalid_grant_type"
	OAuthErrorReason_InvalidOrigin                       OAuthErrorReason = "invalid_origin"
	OAuthErrorReason_InvalidOriginOpaque                 OAuthErrorReason = "invalid_origin_opaque"
	OAuthErrorReason_InvalidPkceCodeVerifier             OAuthErrorReason = "invalid_pkce_code_verifier"
	OAuthErrorReason_InvalidPkceCodeChallenge            OAuthErrorReason = "invalid_pkce_code_challenge"
	OAuthErrorReason_InvalidPkceCodeChallengeMethod      OAuthErrorReason = "invalid_pkce_code_challenge_method"
	OAuthErrorReason_InvalidRedirectUri                  OAuthErrorReason = "invalid_redirect_uri"
	OAuthErrorReason_InvalidResponseMode                 OAuthErrorReason = "invalid_response_mode"
	OAuthErrorReason_InvalidResponseType                 OAuthErrorReason = "invalid_response_type"
	OAuthErrorReason_InvalidIdTokenHint                  OAuthErrorReason = "invalid_id_token_hint"
	OAuthErrorReason_InvalidPostLogoutRedirectUri        OAuthErrorReason = "invalid_post_logout_redirect_uri"
	OAuthErrorReason_InvalidDeviceCode                   OAuthErrorReason = "invalid_device_code"
	OAuthErrorReason_InvalidUserCode                     OAuthErrorReason = "invalid_user_code"
	OAuthErrorReason_InvalidAdditionalClientId           OAuthErrorReason = "invalid_additional_client_id"
	OAuthErrorReason_InvalidTargetEntityScope            OAuthErrorReason = "invalid_target_entity_scope"
	OAuthErrorReason_InvalidEntityPermissionScope        OAuthErrorReason = "invalid_entity_permission_scope"
	OAuthErrorReason_InvalidUserId                       OAuthErrorReason = "invalid_user_id"
	OAuthErrorReason_GrantTypeDisabled                   OAuthErrorReason = "grant_type_disabled"
	OAuthErrorReason_MissingClientId                     OAuthErrorReason = "missing_client_id"
	OAuthErrorReason_MissingClientSecret                 OAuthErrorReason = "missing_client_secret"
	OAuthErrorReason_MissingCode                         OAuthErrorReason = "missing_code"
	OAuthErrorReason_MissingCodeChallenge                OAuthErrorReason = "missing_code_challenge"
	OAuthErrorReason_MissingCodeVerifier                 OAuthErrorReason = "missing_code_verifier"
	OAuthErrorReason_MissingDeviceCode                   OAuthErrorReason = "missing_device_code"
	OAuthErrorReason_MissingGrantType                    OAuthErrorReason = "missing_grant_type"
	OAuthErrorReason_MissingRedirectUri                  OAuthErrorReason = "missing_redirect_uri"
	OAuthErrorReason_MissingRefreshToken                 OAuthErrorReason = "missing_refresh_token"
	OAuthErrorReason_MissingResponseType                 OAuthErrorReason = "missing_response_type"
	OAuthErrorReason_MissingToken                        OAuthErrorReason = "missing_token"
	OAuthErrorReason_MissingUserCode                     OAuthErrorReason = "missing_user_code"
	OAuthErrorReason_MissingUserId                       OAuthErrorReason = "missing_user_id"
	OAuthErrorReason_MissingVerificationUri              OAuthErrorReason = "missing_verification_uri"
	OAuthErrorReason_LoginPrevented                      OAuthErrorReason = "login_prevented"
	OAuthErrorReason_NotLicensed                         OAuthErrorReason = "not_licensed"
	OAuthErrorReason_UserCodeExpired                     OAuthErrorReason = "user_code_expired"
	OAuthErrorReason_UserExpired                         OAuthErrorReason = "user_expired"
	OAuthErrorReason_UserLocked                          OAuthErrorReason = "user_locked"
	OAuthErrorReason_UserNotFound                        OAuthErrorReason = "user_not_found"
	OAuthErrorReason_ClientAuthenticationMissing         OAuthErrorReason = "client_authentication_missing"
	OAuthErrorReason_InvalidClientAuthenticationScheme   OAuthErrorReason = "invalid_client_authentication_scheme"
	OAuthErrorReason_InvalidClientAuthentication         OAuthErrorReason = "invalid_client_authentication"
	OAuthErrorReason_ClientIdMismatch                    OAuthErrorReason = "client_id_mismatch"
	OAuthErrorReason_ChangePasswordAdministrative        OAuthErrorReason = "change_password_administrative"
	OAuthErrorReason_ChangePasswordBreached              OAuthErrorReason = "change_password_breached"
	OAuthErrorReason_ChangePasswordExpired               OAuthErrorReason = "change_password_expired"
	OAuthErrorReason_ChangePasswordValidation            OAuthErrorReason = "change_password_validation"
	OAuthErrorReason_Unknown                             OAuthErrorReason = "unknown"
	OAuthErrorReason_MissingRequiredScope                OAuthErrorReason = "missing_required_scope"
	OAuthErrorReason_UnknownScope                        OAuthErrorReason = "unknown_scope"
	OAuthErrorReason_ConsentCanceled                     OAuthErrorReason = "consent_canceled"
)

func (OAuthErrorReason) String 

func (e OAuthErrorReason) String() string

type OAuthErrorType 

type OAuthErrorType string
const (
	OAuthErrorType_InvalidRequest          OAuthErrorType = "invalid_request"
	OAuthErrorType_InvalidClient           OAuthErrorType = "invalid_client"
	OAuthErrorType_InvalidGrant            OAuthErrorType = "invalid_grant"
	OAuthErrorType_InvalidToken            OAuthErrorType = "invalid_token"
	OAuthErrorType_UnauthorizedClient      OAuthErrorType = "unauthorized_client"
	OAuthErrorType_InvalidScope            OAuthErrorType = "invalid_scope"
	OAuthErrorType_ServerError             OAuthErrorType = "server_error"
	OAuthErrorType_UnsupportedGrantType    OAuthErrorType = "unsupported_grant_type"
	OAuthErrorType_UnsupportedResponseType OAuthErrorType = "unsupported_response_type"
	OAuthErrorType_AccessDenied            OAuthErrorType = "access_denied"
	OAuthErrorType_ChangePasswordRequired  OAuthErrorType = "change_password_required"
	OAuthErrorType_NotLicensed             OAuthErrorType = "not_licensed"
	OAuthErrorType_TwoFactorRequired       OAuthErrorType = "two_factor_required"
	OAuthErrorType_AuthorizationPending    OAuthErrorType = "authorization_pending"
	OAuthErrorType_ExpiredToken            OAuthErrorType = "expired_token"
	OAuthErrorType_UnsupportedTokenType    OAuthErrorType = "unsupported_token_type"
)

func (OAuthErrorType) String 

func (e OAuthErrorType) String() string

type OAuthResponse 

type OAuthResponse struct {
	BaseHTTPResponse
}

*

  • @author Daniel DeGroff

func (*OAuthResponse) SetStatus 

func (b *OAuthResponse) SetStatus(status int)

type OAuthScopeConsentMode 

type OAuthScopeConsentMode string

*

  • Controls the policy for requesting user permission to grant access to requested scopes during an OAuth workflow
  • for a third-party application. *
  • @author Spencer Witt
const (
	OAuthScopeConsentMode_AlwaysPrompt     OAuthScopeConsentMode = "AlwaysPrompt"
	OAuthScopeConsentMode_RememberDecision OAuthScopeConsentMode = "RememberDecision"
	OAuthScopeConsentMode_NeverPrompt      OAuthScopeConsentMode = "NeverPrompt"
)

func (OAuthScopeConsentMode) String 

func (e OAuthScopeConsentMode) String() string

type OAuthScopeHandlingPolicy 

type OAuthScopeHandlingPolicy string

*

  • Controls the policy for whether OAuth workflows will more strictly adhere to the OAuth and OIDC specification
  • or run in backwards compatibility mode. *
  • @author David Charles
const (
	OAuthScopeHandlingPolicy_Compatibility OAuthScopeHandlingPolicy = "Compatibility"
	OAuthScopeHandlingPolicy_Strict        OAuthScopeHandlingPolicy = "Strict"
)

func (OAuthScopeHandlingPolicy) String 

func (e OAuthScopeHandlingPolicy) String() string

type Oauth2AuthorizedURLValidationPolicy 

type Oauth2AuthorizedURLValidationPolicy string

*

  • @author Johnathon Wood
const (
	Oauth2AuthorizedURLValidationPolicy_AllowWildcards Oauth2AuthorizedURLValidationPolicy = "AllowWildcards"
	Oauth2AuthorizedURLValidationPolicy_ExactMatch     Oauth2AuthorizedURLValidationPolicy = "ExactMatch"
)

func (Oauth2AuthorizedURLValidationPolicy) String 

func (e Oauth2AuthorizedURLValidationPolicy) String() string

type ObjectIdentifiable 

type ObjectIdentifiable struct {
}

*

  • A marker interface indicating this event is an event that can supply a linked object Id. *
  • @author Spencer Witt

type ObjectState 

type ObjectState string

*

  • @author Daniel DeGroff
const (
	ObjectState_Active        ObjectState = "Active"
	ObjectState_Inactive      ObjectState = "Inactive"
	ObjectState_PendingDelete ObjectState = "PendingDelete"
)

func (ObjectState) String 

func (e ObjectState) String() string

type OpenIdConfiguration 

type OpenIdConfiguration struct {
	BaseHTTPResponse
	AuthorizationEndpoint             string   `json:"authorization_endpoint,omitempty"`
	BackchannelLogoutSupported        bool     `json:"backchannel_logout_supported"`
	ClaimsSupported                   []string `json:"claims_supported,omitempty"`
	DeviceAuthorizationEndpoint       string   `json:"device_authorization_endpoint,omitempty"`
	EndSessionEndpoint                string   `json:"end_session_endpoint,omitempty"`
	FrontchannelLogoutSupported       bool     `json:"frontchannel_logout_supported"`
	GrantTypesSupported               []string `json:"grant_types_supported,omitempty"`
	IdTokenSigningAlgValuesSupported  []string `json:"id_token_signing_alg_values_supported,omitempty"`
	Issuer                            string   `json:"issuer,omitempty"`
	JwksUri                           string   `json:"jwks_uri,omitempty"`
	ResponseModesSupported            []string `json:"response_modes_supported,omitempty"`
	ResponseTypesSupported            []string `json:"response_types_supported,omitempty"`
	ScopesSupported                   []string `json:"scopes_supported,omitempty"`
	SubjectTypesSupported             []string `json:"subject_types_supported,omitempty"`
	TokenEndpoint                     string   `json:"token_endpoint,omitempty"`
	TokenEndpointAuthMethodsSupported []string `json:"token_endpoint_auth_methods_supported,omitempty"`
	UserinfoEndpoint                  string   `json:"userinfo_endpoint,omitempty"`
	UserinfoSigningAlgValuesSupported []string `json:"userinfo_signing_alg_values_supported,omitempty"`
}

*

func (*OpenIdConfiguration) SetStatus 

func (b *OpenIdConfiguration) SetStatus(status int)

type OpenIdConnectApplicationConfiguration 

type OpenIdConnectApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ButtonImageURL string                              `json:"buttonImageURL,omitempty"`
	ButtonText     string                              `json:"buttonText,omitempty"`
	Oauth2         IdentityProviderOauth2Configuration `json:"oauth2,omitempty"`
}

*

  • @author Daniel DeGroff

type OpenIdConnectIdentityProvider 

type OpenIdConnectIdentityProvider struct {
	BaseIdentityProvider
	ButtonImageURL string                              `json:"buttonImageURL,omitempty"`
	ButtonText     string                              `json:"buttonText,omitempty"`
	Domains        []string                            `json:"domains,omitempty"`
	Oauth2         IdentityProviderOauth2Configuration `json:"oauth2,omitempty"`
	PostRequest    bool                                `json:"postRequest"`
}

*

  • @author Daniel DeGroff

type PasswordBreachDetection 

type PasswordBreachDetection struct {
	Enableable
	MatchMode                 BreachMatchMode `json:"matchMode,omitempty"`
	NotifyUserEmailTemplateId string          `json:"notifyUserEmailTemplateId,omitempty"`
	OnLogin                   BreachAction    `json:"onLogin,omitempty"`
}

*

  • @author Daniel DeGroff

type PasswordEncryptionConfiguration 

type PasswordEncryptionConfiguration struct {
	EncryptionScheme              string `json:"encryptionScheme,omitempty"`
	EncryptionSchemeFactor        int    `json:"encryptionSchemeFactor,omitempty"`
	ModifyEncryptionSchemeOnLogin bool   `json:"modifyEncryptionSchemeOnLogin"`
}

*

  • Password Encryption Scheme Configuration *
  • @author Daniel DeGroff

type PasswordValidationRules 

type PasswordValidationRules struct {
	BreachDetection           PasswordBreachDetection   `json:"breachDetection,omitempty"`
	MaxLength                 int                       `json:"maxLength,omitempty"`
	MinLength                 int                       `json:"minLength,omitempty"`
	RememberPreviousPasswords RememberPreviousPasswords `json:"rememberPreviousPasswords,omitempty"`
	RequireMixedCase          bool                      `json:"requireMixedCase"`
	RequireNonAlpha           bool                      `json:"requireNonAlpha"`
	RequireNumber             bool                      `json:"requireNumber"`
	ValidateOnLogin           bool                      `json:"validateOnLogin"`
}

*

  • @author Derek Klatt

type PasswordValidationRulesResponse 

type PasswordValidationRulesResponse struct {
	BaseHTTPResponse
	PasswordValidationRules PasswordValidationRules `json:"passwordValidationRules,omitempty"`
}

*

  • @author Daniel DeGroff

func (*PasswordValidationRulesResponse) SetStatus 

func (b *PasswordValidationRulesResponse) SetStatus(status int)

type PasswordlessConfiguration 

type PasswordlessConfiguration struct {
	Enableable
}

type PasswordlessIdentityProvider 

type PasswordlessIdentityProvider struct {
}

*

  • Interface for all identity providers that are passwordless and do not accept a password.

type PasswordlessLoginRequest 

type PasswordlessLoginRequest struct {
	BaseLoginRequest
	Code             string `json:"code,omitempty"`
	TwoFactorTrustId string `json:"twoFactorTrustId,omitempty"`
}

*

  • @author Daniel DeGroff

type PasswordlessSendRequest 

type PasswordlessSendRequest struct {
	ApplicationId string                 `json:"applicationId,omitempty"`
	Code          string                 `json:"code,omitempty"`
	LoginId       string                 `json:"loginId,omitempty"`
	State         map[string]interface{} `json:"state,omitempty"`
}

*

  • @author Daniel DeGroff

type PasswordlessStartRequest 

type PasswordlessStartRequest struct {
	ApplicationId string                 `json:"applicationId,omitempty"`
	LoginId       string                 `json:"loginId,omitempty"`
	State         map[string]interface{} `json:"state,omitempty"`
}

*

  • @author Daniel DeGroff

type PasswordlessStartResponse 

type PasswordlessStartResponse struct {
	BaseHTTPResponse
	Code string `json:"code,omitempty"`
}

*

  • @author Daniel DeGroff

func (*PasswordlessStartResponse) SetStatus 

func (b *PasswordlessStartResponse) SetStatus(status int)
type PendingIdPLink struct {
	DisplayName                         string                              `json:"displayName,omitempty"`
	Email                               string                              `json:"email,omitempty"`
	IdentityProviderId                  string                              `json:"identityProviderId,omitempty"`
	IdentityProviderLinks               []IdentityProviderLink              `json:"identityProviderLinks,omitempty"`
	IdentityProviderName                string                              `json:"identityProviderName,omitempty"`
	IdentityProviderTenantConfiguration IdentityProviderTenantConfiguration `json:"identityProviderTenantConfiguration,omitempty"`
	IdentityProviderType                IdentityProviderType                `json:"identityProviderType,omitempty"`
	IdentityProviderUserId              string                              `json:"identityProviderUserId,omitempty"`
	User                                User                                `json:"user,omitempty"`
	Username                            string                              `json:"username,omitempty"`
}

*

  • @author Daniel DeGroff

type PendingResponse 

type PendingResponse struct {
	BaseHTTPResponse
	Users []User `json:"users,omitempty"`
}

*

  • @author Brian Pontarelli

func (*PendingResponse) SetStatus 

func (b *PendingResponse) SetStatus(status int)

type PreviewMessageTemplateRequest 

type PreviewMessageTemplateRequest struct {
	Locale          string          `json:"locale,omitempty"`
	MessageTemplate MessageTemplate `json:"messageTemplate,omitempty"`
}

*

  • @author Michael Sleevi

type PreviewMessageTemplateResponse 

type PreviewMessageTemplateResponse struct {
	BaseHTTPResponse
	Errors  Errors     `json:"errors,omitempty"`
	Message SMSMessage `json:"message,omitempty"`
}

*

  • @author Michael Sleevi

func (*PreviewMessageTemplateResponse) SetStatus 

func (b *PreviewMessageTemplateResponse) SetStatus(status int)

type PreviewRequest 

type PreviewRequest struct {
	EmailTemplate EmailTemplate `json:"emailTemplate,omitempty"`
	Locale        string        `json:"locale,omitempty"`
}

*

  • @author Brian Pontarelli

type PreviewResponse 

type PreviewResponse struct {
	BaseHTTPResponse
	Email  Email  `json:"email,omitempty"`
	Errors Errors `json:"errors,omitempty"`
}

*

  • @author Seth Musselman

func (*PreviewResponse) SetStatus 

func (b *PreviewResponse) SetStatus(status int)

type ProofKeyForCodeExchangePolicy 

type ProofKeyForCodeExchangePolicy string

*

  • @author Brett Guy
const (
	ProofKeyForCodeExchangePolicy_Required                                 ProofKeyForCodeExchangePolicy = "Required"
	ProofKeyForCodeExchangePolicy_NotRequired                              ProofKeyForCodeExchangePolicy = "NotRequired"
	ProofKeyForCodeExchangePolicy_NotRequiredWhenUsingClientAuthentication ProofKeyForCodeExchangePolicy = "NotRequiredWhenUsingClientAuthentication"
)

func (ProofKeyForCodeExchangePolicy) String 

func (e ProofKeyForCodeExchangePolicy) String() string

type ProvidedScopePolicy 

type ProvidedScopePolicy struct {
	Address Requirable `json:"address,omitempty"`
	Email   Requirable `json:"email,omitempty"`
	Phone   Requirable `json:"phone,omitempty"`
	Profile Requirable `json:"profile,omitempty"`
}

*

  • The handling policy for scopes provided by FusionAuth *
  • @author Spencer Witt

type ProviderLambdaConfiguration 

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

type PublicKeyCredentialCreationOptions 

type PublicKeyCredentialCreationOptions struct {
	Attestation            AttestationConveyancePreference       `json:"attestation,omitempty"`
	AuthenticatorSelection AuthenticatorSelectionCriteria        `json:"authenticatorSelection,omitempty"`
	Challenge              string                                `json:"challenge,omitempty"`
	ExcludeCredentials     []PublicKeyCredentialDescriptor       `json:"excludeCredentials,omitempty"`
	Extensions             WebAuthnRegistrationExtensionOptions  `json:"extensions,omitempty"`
	PubKeyCredParams       []PublicKeyCredentialParameters       `json:"pubKeyCredParams,omitempty"`
	Rp                     PublicKeyCredentialRelyingPartyEntity `json:"rp,omitempty"`
	Timeout                int64                                 `json:"timeout,omitempty"`
	User                   PublicKeyCredentialUserEntity         `json:"user,omitempty"`
}

*

  • Allows the Relying Party to specify desired attributes of a new credential. *
  • @author Spencer Witt

type PublicKeyCredentialDescriptor 

type PublicKeyCredentialDescriptor struct {
	Id         string                  `json:"id,omitempty"`
	Transports []string                `json:"transports,omitempty"`
	Type       PublicKeyCredentialType `json:"type,omitempty"`
}

*

  • Contains attributes for the Relying Party to refer to an existing public key credential as an input parameter. *
  • @author Spencer Witt

type PublicKeyCredentialEntity 

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

*

  • Describes a user account or WebAuthn Relying Party associated with a public key credential

type PublicKeyCredentialParameters 

type PublicKeyCredentialParameters struct {
	Alg  CoseAlgorithmIdentifier `json:"alg,omitempty"`
	Type PublicKeyCredentialType `json:"type,omitempty"`
}

*

  • Supply information on credential type and algorithm to the <i>authenticator</i>. *
  • @author Spencer Witt

type PublicKeyCredentialRelyingPartyEntity 

type PublicKeyCredentialRelyingPartyEntity struct {
	PublicKeyCredentialEntity
	Id string `json:"id,omitempty"`
}

*

  • Supply additional information about the Relying Party when creating a new credential *
  • @author Spencer Witt

type PublicKeyCredentialRequestOptions 

type PublicKeyCredentialRequestOptions struct {
	AllowCredentials []PublicKeyCredentialDescriptor `json:"allowCredentials,omitempty"`
	Challenge        string                          `json:"challenge,omitempty"`
	RpId             string                          `json:"rpId,omitempty"`
	Timeout          int64                           `json:"timeout,omitempty"`
	UserVerification UserVerificationRequirement     `json:"userVerification,omitempty"`
}

*

  • Provides the <i>authenticator</i> with the data it needs to generate an assertion. *
  • @author Spencer Witt

type PublicKeyCredentialType 

type PublicKeyCredentialType string

*

  • Defines valid credential types. This is an extension point in the WebAuthn spec. The only defined value at this time is "public-key" *
  • @author Spencer Witt
const (
	PublicKeyCredentialType_PublicKey PublicKeyCredentialType = "publicKey"
)

func (PublicKeyCredentialType) String 

func (e PublicKeyCredentialType) String() string

type PublicKeyCredentialUserEntity 

type PublicKeyCredentialUserEntity struct {
	PublicKeyCredentialEntity
	DisplayName string `json:"displayName,omitempty"`
	Id          string `json:"id,omitempty"`
}

*

  • Supply additional information about the user account when creating a new credential *
  • @author Spencer Witt

type PublicKeyResponse 

type PublicKeyResponse struct {
	BaseHTTPResponse
	PublicKey  string            `json:"publicKey,omitempty"`
	PublicKeys map[string]string `json:"publicKeys,omitempty"`
}

*

  • JWT Public Key Response Object *
  • @author Daniel DeGroff

func (*PublicKeyResponse) SetStatus 

func (b *PublicKeyResponse) SetStatus(status int)

type RateLimitedRequestConfiguration 

type RateLimitedRequestConfiguration struct {
	Enableable
	Limit               int `json:"limit,omitempty"`
	TimePeriodInSeconds int `json:"timePeriodInSeconds,omitempty"`
}

*

  • @author Daniel DeGroff

type RateLimitedRequestType 

type RateLimitedRequestType string

*

  • @author Daniel DeGroff
const (
	RateLimitedRequestType_FailedLogin                  RateLimitedRequestType = "FailedLogin"
	RateLimitedRequestType_ForgotPassword               RateLimitedRequestType = "ForgotPassword"
	RateLimitedRequestType_SendEmailVerification        RateLimitedRequestType = "SendEmailVerification"
	RateLimitedRequestType_SendPasswordless             RateLimitedRequestType = "SendPasswordless"
	RateLimitedRequestType_SendRegistrationVerification RateLimitedRequestType = "SendRegistrationVerification"
	RateLimitedRequestType_SendTwoFactor                RateLimitedRequestType = "SendTwoFactor"
)

func (RateLimitedRequestType) String 

func (e RateLimitedRequestType) String() string

type RawLogin 

type RawLogin struct {
	ApplicationId string `json:"applicationId,omitempty"`
	Instant       int64  `json:"instant,omitempty"`
	IpAddress     string `json:"ipAddress,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • Raw login information for each time a user logs into an application. *
  • @author Brian Pontarelli

type ReactorFeatureStatus 

type ReactorFeatureStatus string

*

  • @author Brian Pontarelli
const (
	ReactorFeatureStatus_ACTIVE       ReactorFeatureStatus = "ACTIVE"
	ReactorFeatureStatus_DISCONNECTED ReactorFeatureStatus = "DISCONNECTED"
	ReactorFeatureStatus_PENDING      ReactorFeatureStatus = "PENDING"
	ReactorFeatureStatus_DISABLED     ReactorFeatureStatus = "DISABLED"
	ReactorFeatureStatus_UNKNOWN      ReactorFeatureStatus = "UNKNOWN"
)

func (ReactorFeatureStatus) String 

func (e ReactorFeatureStatus) String() string

type ReactorMetrics 

type ReactorMetrics struct {
	BreachedPasswordMetrics map[string]BreachedPasswordTenantMetric `json:"breachedPasswordMetrics,omitempty"`
}

*

  • @author Daniel DeGroff

type ReactorMetricsResponse 

type ReactorMetricsResponse struct {
	BaseHTTPResponse
	Metrics ReactorMetrics `json:"metrics,omitempty"`
}

*

  • @author Daniel DeGroff

func (*ReactorMetricsResponse) SetStatus 

func (b *ReactorMetricsResponse) SetStatus(status int)

type ReactorRequest 

type ReactorRequest struct {
	License   string `json:"license,omitempty"`
	LicenseId string `json:"licenseId,omitempty"`
}

*

  • Request for managing FusionAuth Reactor and licenses. *
  • @author Brian Pontarelli

type ReactorResponse 

type ReactorResponse struct {
	BaseHTTPResponse
	Status ReactorStatus `json:"status,omitempty"`
}

*

  • @author Daniel DeGroff

func (*ReactorResponse) SetStatus 

func (b *ReactorResponse) SetStatus(status int)

type ReactorStatus 

type ReactorStatus struct {
	AdvancedIdentityProviders                 ReactorFeatureStatus `json:"advancedIdentityProviders,omitempty"`
	AdvancedLambdas                           ReactorFeatureStatus `json:"advancedLambdas,omitempty"`
	AdvancedMultiFactorAuthentication         ReactorFeatureStatus `json:"advancedMultiFactorAuthentication,omitempty"`
	AdvancedOAuthScopes                       ReactorFeatureStatus `json:"advancedOAuthScopes,omitempty"`
	AdvancedOAuthScopesCustomScopes           ReactorFeatureStatus `json:"advancedOAuthScopesCustomScopes,omitempty"`
	AdvancedOAuthScopesThirdPartyApplications ReactorFeatureStatus `json:"advancedOAuthScopesThirdPartyApplications,omitempty"`
	AdvancedRegistration                      ReactorFeatureStatus `json:"advancedRegistration,omitempty"`
	ApplicationMultiFactorAuthentication      ReactorFeatureStatus `json:"applicationMultiFactorAuthentication,omitempty"`
	ApplicationThemes                         ReactorFeatureStatus `json:"applicationThemes,omitempty"`
	BreachedPasswordDetection                 ReactorFeatureStatus `json:"breachedPasswordDetection,omitempty"`
	Connectors                                ReactorFeatureStatus `json:"connectors,omitempty"`
	EntityManagement                          ReactorFeatureStatus `json:"entityManagement,omitempty"`
	Expiration                                string               `json:"expiration,omitempty"`
	LicenseAttributes                         map[string]string    `json:"licenseAttributes,omitempty"`
	Licensed                                  bool                 `json:"licensed"`
	ScimServer                                ReactorFeatureStatus `json:"scimServer,omitempty"`
	ThreatDetection                           ReactorFeatureStatus `json:"threatDetection,omitempty"`
	WebAuthn                                  ReactorFeatureStatus `json:"webAuthn,omitempty"`
	WebAuthnPlatformAuthenticators            ReactorFeatureStatus `json:"webAuthnPlatformAuthenticators,omitempty"`
	WebAuthnRoamingAuthenticators             ReactorFeatureStatus `json:"webAuthnRoamingAuthenticators,omitempty"`
}

*

  • @author Daniel DeGroff

type RecentLoginResponse 

type RecentLoginResponse struct {
	BaseHTTPResponse
	Logins []DisplayableRawLogin `json:"logins,omitempty"`
}

*

  • Response for the user login report. *
  • @author Seth Musselman

func (*RecentLoginResponse) SetStatus 

func (b *RecentLoginResponse) SetStatus(status int)

type RefreshRequest 

type RefreshRequest struct {
	BaseEventRequest
	RefreshToken string `json:"refreshToken,omitempty"`
	Token        string `json:"token,omitempty"`
}

*

  • @author Daniel DeGroff

type RefreshResponse 

type RefreshResponse struct {
	BaseHTTPResponse
}

*

  • @author Daniel DeGroff

func (*RefreshResponse) SetStatus 

func (b *RefreshResponse) SetStatus(status int)

type RefreshToken 

type RefreshToken struct {
	ApplicationId string                 `json:"applicationId,omitempty"`
	Data          map[string]interface{} `json:"data,omitempty"`
	Id            string                 `json:"id,omitempty"`
	InsertInstant int64                  `json:"insertInstant,omitempty"`
	MetaData      MetaData               `json:"metaData,omitempty"`
	StartInstant  int64                  `json:"startInstant,omitempty"`
	TenantId      string                 `json:"tenantId,omitempty"`
	Token         string                 `json:"token,omitempty"`
	UserId        string                 `json:"userId,omitempty"`
}

*

  • Models a JWT Refresh Token. *
  • @author Daniel DeGroff

type RefreshTokenExpirationPolicy 

type RefreshTokenExpirationPolicy string

*

  • @author Daniel DeGroff
const (
	RefreshTokenExpirationPolicy_Fixed                            RefreshTokenExpirationPolicy = "Fixed"
	RefreshTokenExpirationPolicy_SlidingWindow                    RefreshTokenExpirationPolicy = "SlidingWindow"
	RefreshTokenExpirationPolicy_SlidingWindowWithMaximumLifetime RefreshTokenExpirationPolicy = "SlidingWindowWithMaximumLifetime"
)

func (RefreshTokenExpirationPolicy) String 

func (e RefreshTokenExpirationPolicy) String() string

type RefreshTokenImportRequest 

type RefreshTokenImportRequest struct {
	RefreshTokens         []RefreshToken `json:"refreshTokens,omitempty"`
	ValidateDbConstraints bool           `json:"validateDbConstraints"`
}

*

  • Refresh Token Import request. *
  • @author Brett Guy

type RefreshTokenOneTimeUseConfiguration 

type RefreshTokenOneTimeUseConfiguration struct {
	GracePeriodInSeconds int `json:"gracePeriodInSeconds,omitempty"`
}

*

  • Refresh token one-time use configuration. This configuration is utilized when the usage policy is
  • configured for one-time use. *
  • @author Daniel DeGroff

type RefreshTokenResponse 

type RefreshTokenResponse struct {
	BaseHTTPResponse
	RefreshToken  RefreshToken   `json:"refreshToken,omitempty"`
	RefreshTokens []RefreshToken `json:"refreshTokens,omitempty"`
}

*

  • API response for retrieving Refresh Tokens *
  • @author Daniel DeGroff

func (*RefreshTokenResponse) SetStatus 

func (b *RefreshTokenResponse) SetStatus(status int)

type RefreshTokenRevocationPolicy 

type RefreshTokenRevocationPolicy struct {
	OnLoginPrevented    bool `json:"onLoginPrevented"`
	OnMultiFactorEnable bool `json:"onMultiFactorEnable"`
	OnOneTimeTokenReuse bool `json:"onOneTimeTokenReuse"`
	OnPasswordChanged   bool `json:"onPasswordChanged"`
}

*

  • @author Daniel DeGroff

type RefreshTokenRevokeRequest 

type RefreshTokenRevokeRequest struct {
	BaseEventRequest
	ApplicationId string `json:"applicationId,omitempty"`
	Token         string `json:"token,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • Request for the Refresh Token API to revoke a refresh token rather than using the URL parameters. *
  • @author Brian Pontarelli

type RefreshTokenSlidingWindowConfiguration 

type RefreshTokenSlidingWindowConfiguration struct {
	MaximumTimeToLiveInMinutes int `json:"maximumTimeToLiveInMinutes,omitempty"`
}

*

  • @author Daniel DeGroff

type RefreshTokenUsagePolicy 

type RefreshTokenUsagePolicy string

*

  • @author Daniel DeGroff
const (
	RefreshTokenUsagePolicy_Reusable   RefreshTokenUsagePolicy = "Reusable"
	RefreshTokenUsagePolicy_OneTimeUse RefreshTokenUsagePolicy = "OneTimeUse"
)

func (RefreshTokenUsagePolicy) String 

func (e RefreshTokenUsagePolicy) String() string

type RegistrationConfiguration 

type RegistrationConfiguration struct {
	Enableable
	BirthDate          Requirable       `json:"birthDate,omitempty"`
	ConfirmPassword    bool             `json:"confirmPassword"`
	FirstName          Requirable       `json:"firstName,omitempty"`
	FormId             string           `json:"formId,omitempty"`
	FullName           Requirable       `json:"fullName,omitempty"`
	LastName           Requirable       `json:"lastName,omitempty"`
	LoginIdType        LoginIdType      `json:"loginIdType,omitempty"`
	MiddleName         Requirable       `json:"middleName,omitempty"`
	MobilePhone        Requirable       `json:"mobilePhone,omitempty"`
	PreferredLanguages Requirable       `json:"preferredLanguages,omitempty"`
	Type               RegistrationType `json:"type,omitempty"`
}

type RegistrationDeleteRequest 

type RegistrationDeleteRequest struct {
	BaseEventRequest
}

*

  • Registration delete API request object. *
  • @author Brian Pontarelli

type RegistrationReportResponse 

type RegistrationReportResponse struct {
	BaseHTTPResponse
	HourlyCounts []Count `json:"hourlyCounts,omitempty"`
	Total        int64   `json:"total,omitempty"`
}

*

  • Response for the registration report. *
  • @author Brian Pontarelli

func (*RegistrationReportResponse) SetStatus 

func (b *RegistrationReportResponse) SetStatus(status int)

type RegistrationRequest 

type RegistrationRequest struct {
	BaseEventRequest
	DisableDomainBlock           bool             `json:"disableDomainBlock"`
	GenerateAuthenticationToken  bool             `json:"generateAuthenticationToken"`
	Registration                 UserRegistration `json:"registration,omitempty"`
	SendSetPasswordEmail         bool             `json:"sendSetPasswordEmail"`
	SkipRegistrationVerification bool             `json:"skipRegistrationVerification"`
	SkipVerification             bool             `json:"skipVerification"`
	User                         User             `json:"user,omitempty"`
}

*

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

type RegistrationResponse 

type RegistrationResponse struct {
	BaseHTTPResponse
	RefreshToken                        string           `json:"refreshToken,omitempty"`
	RefreshTokenId                      string           `json:"refreshTokenId,omitempty"`
	Registration                        UserRegistration `json:"registration,omitempty"`
	RegistrationVerificationId          string           `json:"registrationVerificationId,omitempty"`
	RegistrationVerificationOneTimeCode string           `json:"registrationVerificationOneTimeCode,omitempty"`
	Token                               string           `json:"token,omitempty"`
	TokenExpirationInstant              int64            `json:"tokenExpirationInstant,omitempty"`
	User                                User             `json:"user,omitempty"`
}

*

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

func (*RegistrationResponse) SetStatus 

func (b *RegistrationResponse) SetStatus(status int)

type RegistrationType 

type RegistrationType string
const (
	RegistrationType_Basic    RegistrationType = "basic"
	RegistrationType_Advanced RegistrationType = "advanced"
)

func (RegistrationType) String 

func (e RegistrationType) String() string

type RegistrationUnverifiedOptions 

type RegistrationUnverifiedOptions struct {
	Behavior UnverifiedBehavior `json:"behavior,omitempty"`
}

*

  • @author Daniel DeGroff

type ReindexRequest 

type ReindexRequest struct {
	Index string `json:"index,omitempty"`
}

*

  • Reindex API request *
  • @author Daniel DeGroff

type ReloadRequest 

type ReloadRequest struct {
	Names []string `json:"names,omitempty"`
}

*

  • @author Daniel DeGroff

type RememberPreviousPasswords 

type RememberPreviousPasswords struct {
	Enableable
	Count int `json:"count,omitempty"`
}

*

  • @author Daniel DeGroff

type Requirable 

type Requirable struct {
	Enableable
	Required bool `json:"required"`
}

*

  • Something that can be required and thus also optional. This currently extends Enableable because anything that is
  • required/optional is almost always enableable as well. *
  • @author Brian Pontarelli

type RequiresCORSConfiguration 

type RequiresCORSConfiguration struct {
}

*

  • Interface describing the need for CORS configuration. *
  • @author Daniel DeGroff

type ResidentKeyRequirement 

type ResidentKeyRequirement string

* 

const (
	ResidentKeyRequirement_Discouraged ResidentKeyRequirement = "discouraged"
	ResidentKeyRequirement_Preferred   ResidentKeyRequirement = "preferred"
	ResidentKeyRequirement_Required    ResidentKeyRequirement = "required"
)

func (ResidentKeyRequirement) String 

func (e ResidentKeyRequirement) String() string

type SAMLLogoutBehavior 

type SAMLLogoutBehavior string
const (
	SAMLLogoutBehavior_AllParticipants SAMLLogoutBehavior = "AllParticipants"
	SAMLLogoutBehavior_OnlyOriginator  SAMLLogoutBehavior = "OnlyOriginator"
)

func (SAMLLogoutBehavior) String 

func (e SAMLLogoutBehavior) String() string

type SAMLv2ApplicationConfiguration 

type SAMLv2ApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ButtonImageURL string `json:"buttonImageURL,omitempty"`
	ButtonText     string `json:"buttonText,omitempty"`
}

*

  • @author Brian Pontarelli

type SAMLv2AssertionConfiguration 

type SAMLv2AssertionConfiguration struct {
	Destination SAMLv2DestinationAssertionConfiguration `json:"destination,omitempty"`
}

*

  • @author Lyle Schemmerling

type SAMLv2AssertionDecryptionConfiguration 

type SAMLv2AssertionDecryptionConfiguration struct {
	Enableable
	KeyTransportDecryptionKeyId string `json:"keyTransportDecryptionKeyId,omitempty"`
}

*

  • Configuration for encrypted assertions when acting as SAML Service Provider *
  • @author Jaret Hendrickson

type SAMLv2AssertionEncryptionConfiguration 

type SAMLv2AssertionEncryptionConfiguration struct {
	Enableable
	DigestAlgorithm             string `json:"digestAlgorithm,omitempty"`
	EncryptionAlgorithm         string `json:"encryptionAlgorithm,omitempty"`
	KeyLocation                 string `json:"keyLocation,omitempty"`
	KeyTransportAlgorithm       string `json:"keyTransportAlgorithm,omitempty"`
	KeyTransportEncryptionKeyId string `json:"keyTransportEncryptionKeyId,omitempty"`
	MaskGenerationFunction      string `json:"maskGenerationFunction,omitempty"`
}

type SAMLv2Configuration 

type SAMLv2Configuration struct {
	Enableable
	AssertionEncryptionConfiguration SAMLv2AssertionEncryptionConfiguration `json:"assertionEncryptionConfiguration,omitempty"`
	Audience                         string                                 `json:"audience,omitempty"`
	AuthorizedRedirectURLs           []string                               `json:"authorizedRedirectURLs,omitempty"`
	CallbackURL                      string                                 `json:"callbackURL,omitempty"`
	Debug                            bool                                   `json:"debug"`
	DefaultVerificationKeyId         string                                 `json:"defaultVerificationKeyId,omitempty"`
	InitiatedLogin                   SAMLv2IdPInitiatedLoginConfiguration   `json:"initiatedLogin,omitempty"`
	Issuer                           string                                 `json:"issuer,omitempty"`
	KeyId                            string                                 `json:"keyId,omitempty"`
	LoginHintConfiguration           LoginHintConfiguration                 `json:"loginHintConfiguration,omitempty"`
	Logout                           SAMLv2Logout                           `json:"logout,omitempty"`
	LogoutURL                        string                                 `json:"logoutURL,omitempty"`
	RequireSignedRequests            bool                                   `json:"requireSignedRequests"`
	XmlSignatureC14nMethod           CanonicalizationMethod                 `json:"xmlSignatureC14nMethod,omitempty"`
	XmlSignatureLocation             XMLSignatureLocation                   `json:"xmlSignatureLocation,omitempty"`
}

type SAMLv2DestinationAssertionConfiguration 

type SAMLv2DestinationAssertionConfiguration struct {
	Alternates []string                         `json:"alternates,omitempty"`
	Policy     SAMLv2DestinationAssertionPolicy `json:"policy,omitempty"`
}

*

  • @author Lyle Schemmerling

type SAMLv2DestinationAssertionPolicy 

type SAMLv2DestinationAssertionPolicy string

*

  • @author Lyle Schemmerling
const (
	SAMLv2DestinationAssertionPolicy_Enabled         SAMLv2DestinationAssertionPolicy = "Enabled"
	SAMLv2DestinationAssertionPolicy_Disabled        SAMLv2DestinationAssertionPolicy = "Disabled"
	SAMLv2DestinationAssertionPolicy_AllowAlternates SAMLv2DestinationAssertionPolicy = "AllowAlternates"
)

func (SAMLv2DestinationAssertionPolicy) String 

func (e SAMLv2DestinationAssertionPolicy) String() string

type SAMLv2IdPInitiatedApplicationConfiguration 

type SAMLv2IdPInitiatedApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
}

*

  • @author Daniel DeGroff

type SAMLv2IdPInitiatedIdentityProvider 

type SAMLv2IdPInitiatedIdentityProvider struct {
	BaseSAMLv2IdentityProvider
	Issuer string `json:"issuer,omitempty"`
}

*

  • SAML v2 IdP Initiated identity provider configuration. *
  • @author Daniel DeGroff

type SAMLv2IdPInitiatedLoginConfiguration 

type SAMLv2IdPInitiatedLoginConfiguration struct {
	Enableable
	NameIdFormat string `json:"nameIdFormat,omitempty"`
}

*

  • IdP Initiated login configuration *
  • @author Daniel DeGroff

type SAMLv2IdentityProvider 

type SAMLv2IdentityProvider struct {
	BaseSAMLv2IdentityProvider
	AssertionConfiguration    SAMLv2AssertionConfiguration    `json:"assertionConfiguration,omitempty"`
	ButtonImageURL            string                          `json:"buttonImageURL,omitempty"`
	ButtonText                string                          `json:"buttonText,omitempty"`
	Domains                   []string                        `json:"domains,omitempty"`
	IdpEndpoint               string                          `json:"idpEndpoint,omitempty"`
	IdpInitiatedConfiguration SAMLv2IdpInitiatedConfiguration `json:"idpInitiatedConfiguration,omitempty"`
	Issuer                    string                          `json:"issuer,omitempty"`
	LoginHintConfiguration    LoginHintConfiguration          `json:"loginHintConfiguration,omitempty"`
	NameIdFormat              string                          `json:"nameIdFormat,omitempty"`
	PostRequest               bool                            `json:"postRequest"`
	RequestSigningKeyId       string                          `json:"requestSigningKeyId,omitempty"`
	SignRequest               bool                            `json:"signRequest"`
	XmlSignatureC14nMethod    CanonicalizationMethod          `json:"xmlSignatureC14nMethod,omitempty"`
}

*

  • SAML v2 identity provider configuration. *
  • @author Brian Pontarelli

type SAMLv2IdpInitiatedConfiguration 

type SAMLv2IdpInitiatedConfiguration struct {
	Enableable
	Issuer string `json:"issuer,omitempty"`
}

*

  • Config for regular SAML IDP configurations that support IdP initiated requests *
  • @author Lyle Schemmerling

type SAMLv2Logout 

type SAMLv2Logout struct {
	Behavior                 SAMLLogoutBehavior     `json:"behavior,omitempty"`
	DefaultVerificationKeyId string                 `json:"defaultVerificationKeyId,omitempty"`
	KeyId                    string                 `json:"keyId,omitempty"`
	RequireSignedRequests    bool                   `json:"requireSignedRequests"`
	SingleLogout             SAMLv2SingleLogout     `json:"singleLogout,omitempty"`
	XmlSignatureC14nMethod   CanonicalizationMethod `json:"xmlSignatureC14nMethod,omitempty"`
}

type SAMLv2SingleLogout 

type SAMLv2SingleLogout struct {
	Enableable
	KeyId                  string                 `json:"keyId,omitempty"`
	Url                    string                 `json:"url,omitempty"`
	XmlSignatureC14nMethod CanonicalizationMethod `json:"xmlSignatureC14nMethod,omitempty"`
}

type SMSMessage 

type SMSMessage struct {
	PhoneNumber string `json:"phoneNumber,omitempty"`
	TextMessage string `json:"textMessage,omitempty"`
}

*

  • @author Michael Sleevi

type SMSMessageTemplate 

type SMSMessageTemplate struct {
	MessageTemplate
	DefaultTemplate    string            `json:"defaultTemplate,omitempty"`
	LocalizedTemplates map[string]string `json:"localizedTemplates,omitempty"`
}

*

  • @author Michael Sleevi

type SearchRequest 

type SearchRequest struct {
	ExpandableRequest
	Search UserSearchCriteria `json:"search,omitempty"`
}

*

  • Search API request. *
  • @author Brian Pontarelli

type SearchResponse 

type SearchResponse struct {
	BaseHTTPResponse
	ExpandableResponse
	NextResults string `json:"nextResults,omitempty"`
	Total       int64  `json:"total,omitempty"`
	Users       []User `json:"users,omitempty"`
}

*

  • Search API response. *
  • @author Brian Pontarelli

func (*SearchResponse) SetStatus 

func (b *SearchResponse) SetStatus(status int)

type SearchResults 

type SearchResults struct {
	NextResults        string        `json:"nextResults,omitempty"`
	Results            []interface{} `json:"results,omitempty"`
	Total              int64         `json:"total,omitempty"`
	TotalEqualToActual bool          `json:"totalEqualToActual"`
}

*

  • Search results. *
  • @author Brian Pontarelli

type SecretResponse 

type SecretResponse struct {
	BaseHTTPResponse
	Secret              string `json:"secret,omitempty"`
	SecretBase32Encoded string `json:"secretBase32Encoded,omitempty"`
}

*

  • @author Daniel DeGroff

func (*SecretResponse) SetStatus 

func (b *SecretResponse) SetStatus(status int)

type SecureGeneratorConfiguration 

type SecureGeneratorConfiguration struct {
	Length int                 `json:"length,omitempty"`
	Type   SecureGeneratorType `json:"type,omitempty"`
}

*

  • @author Daniel DeGroff

type SecureGeneratorType 

type SecureGeneratorType string

*

  • @author Daniel DeGroff
const (
	SecureGeneratorType_RandomDigits       SecureGeneratorType = "randomDigits"
	SecureGeneratorType_RandomBytes        SecureGeneratorType = "randomBytes"
	SecureGeneratorType_RandomAlpha        SecureGeneratorType = "randomAlpha"
	SecureGeneratorType_RandomAlphaNumeric SecureGeneratorType = "randomAlphaNumeric"
)

func (SecureGeneratorType) String 

func (e SecureGeneratorType) String() string

type SecureIdentity 

type SecureIdentity struct {
	BreachedPasswordLastCheckedInstant int64                  `json:"breachedPasswordLastCheckedInstant,omitempty"`
	BreachedPasswordStatus             BreachedPasswordStatus `json:"breachedPasswordStatus,omitempty"`
	ConnectorId                        string                 `json:"connectorId,omitempty"`
	EncryptionScheme                   string                 `json:"encryptionScheme,omitempty"`
	Factor                             int                    `json:"factor,omitempty"`
	Id                                 string                 `json:"id,omitempty"`
	LastLoginInstant                   int64                  `json:"lastLoginInstant,omitempty"`
	Password                           string                 `json:"password,omitempty"`
	PasswordChangeReason               ChangePasswordReason   `json:"passwordChangeReason,omitempty"`
	PasswordChangeRequired             bool                   `json:"passwordChangeRequired"`
	PasswordLastUpdateInstant          int64                  `json:"passwordLastUpdateInstant,omitempty"`
	Salt                               string                 `json:"salt,omitempty"`
	UniqueUsername                     string                 `json:"uniqueUsername,omitempty"`
	Username                           string                 `json:"username,omitempty"`
	UsernameStatus                     ContentStatus          `json:"usernameStatus,omitempty"`
	Verified                           bool                   `json:"verified"`
	VerifiedInstant                    int64                  `json:"verifiedInstant,omitempty"`
}

*

  • @author Daniel DeGroff

type SelfServiceFormConfiguration 

type SelfServiceFormConfiguration struct {
	RequireCurrentPasswordOnPasswordChange bool `json:"requireCurrentPasswordOnPasswordChange"`
}

*

  • @author andrewpai

type SendRequest 

type SendRequest struct {
	ApplicationId      string                 `json:"applicationId,omitempty"`
	BccAddresses       []string               `json:"bccAddresses,omitempty"`
	CcAddresses        []string               `json:"ccAddresses,omitempty"`
	PreferredLanguages []string               `json:"preferredLanguages,omitempty"`
	RequestData        map[string]interface{} `json:"requestData,omitempty"`
	ToAddresses        []EmailAddress         `json:"toAddresses,omitempty"`
	UserIds            []string               `json:"userIds,omitempty"`
}

*

  • @author Daniel DeGroff

type SendResponse 

type SendResponse struct {
	BaseHTTPResponse
	AnonymousResults map[string]EmailTemplateErrors `json:"anonymousResults,omitempty"`
	Results          map[string]EmailTemplateErrors `json:"results,omitempty"`
}

*

  • @author Daniel DeGroff

func (*SendResponse) SetStatus 

func (b *SendResponse) SetStatus(status int)

type SimpleThemeVariables 

type SimpleThemeVariables struct {
	AlertBackgroundColor        string `json:"alertBackgroundColor,omitempty"`
	AlertFontColor              string `json:"alertFontColor,omitempty"`
	BackgroundImageURL          string `json:"backgroundImageURL,omitempty"`
	BackgroundSize              string `json:"backgroundSize,omitempty"`
	BorderRadius                string `json:"borderRadius,omitempty"`
	DeleteButtonColor           string `json:"deleteButtonColor,omitempty"`
	DeleteButtonFocusColor      string `json:"deleteButtonFocusColor,omitempty"`
	DeleteButtonTextColor       string `json:"deleteButtonTextColor,omitempty"`
	DeleteButtonTextFocusColor  string `json:"deleteButtonTextFocusColor,omitempty"`
	ErrorFontColor              string `json:"errorFontColor,omitempty"`
	ErrorIconColor              string `json:"errorIconColor,omitempty"`
	FontColor                   string `json:"fontColor,omitempty"`
	FontFamily                  string `json:"fontFamily,omitempty"`
	FooterDisplay               bool   `json:"footerDisplay"`
	IconBackgroundColor         string `json:"iconBackgroundColor,omitempty"`
	IconColor                   string `json:"iconColor,omitempty"`
	InfoIconColor               string `json:"infoIconColor,omitempty"`
	InputBackgroundColor        string `json:"inputBackgroundColor,omitempty"`
	InputIconColor              string `json:"inputIconColor,omitempty"`
	InputTextColor              string `json:"inputTextColor,omitempty"`
	LinkTextColor               string `json:"linkTextColor,omitempty"`
	LinkTextFocusColor          string `json:"linkTextFocusColor,omitempty"`
	LogoImageSize               string `json:"logoImageSize,omitempty"`
	LogoImageURL                string `json:"logoImageURL,omitempty"`
	MonoFontColor               string `json:"monoFontColor,omitempty"`
	MonoFontFamily              string `json:"monoFontFamily,omitempty"`
	PageBackgroundColor         string `json:"pageBackgroundColor,omitempty"`
	PanelBackgroundColor        string `json:"panelBackgroundColor,omitempty"`
	PrimaryButtonColor          string `json:"primaryButtonColor,omitempty"`
	PrimaryButtonFocusColor     string `json:"primaryButtonFocusColor,omitempty"`
	PrimaryButtonTextColor      string `json:"primaryButtonTextColor,omitempty"`
	PrimaryButtonTextFocusColor string `json:"primaryButtonTextFocusColor,omitempty"`
}

*

  • Theme object for values used in the css variables for simple themes. *
  • @author Lyle Schemmerling

type SonyPSNApplicationConfiguration 

type SonyPSNApplicationConfiguration 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 SonyPSNIdentityProvider 

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

*

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

type Sort 

type Sort string

*

  • @author Daniel DeGroff
const (
	Sort_Asc  Sort = "asc"
	Sort_Desc Sort = "desc"
)

func (Sort) String 

func (e Sort) String() string

type SortField 

type SortField struct {
	Missing string `json:"missing,omitempty"`
	Name    string `json:"name,omitempty"`
	Order   Sort   `json:"order,omitempty"`
}

*

  • @author Daniel DeGroff

type StatusAble 

type StatusAble interface {
	SetStatus(status int)
}

type StatusResponse 

type StatusResponse struct {
	BaseHTTPResponse
	LinkedHashMap
}

*

  • The public Status API response *
  • @author Daniel DeGroff

func (*StatusResponse) SetStatus 

func (b *StatusResponse) SetStatus(status int)

type SteamAPIMode 

type SteamAPIMode string

*

  • Steam API modes. *
  • @author Daniel DeGroff
const (
	SteamAPIMode_Public  SteamAPIMode = "Public"
	SteamAPIMode_Partner SteamAPIMode = "Partner"
)

func (SteamAPIMode) String 

func (e SteamAPIMode) String() string

type SteamApplicationConfiguration 

type SteamApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ApiMode    SteamAPIMode `json:"apiMode,omitempty"`
	ButtonText string       `json:"buttonText,omitempty"`
	ClientId   string       `json:"client_id,omitempty"`
	Scope      string       `json:"scope,omitempty"`
	WebAPIKey  string       `json:"webAPIKey,omitempty"`
}

*

  • @author Brett Pontarelli

type SteamIdentityProvider 

type SteamIdentityProvider struct {
	BaseIdentityProvider
	ApiMode    SteamAPIMode `json:"apiMode,omitempty"`
	ButtonText string       `json:"buttonText,omitempty"`
	ClientId   string       `json:"client_id,omitempty"`
	Scope      string       `json:"scope,omitempty"`
	WebAPIKey  string       `json:"webAPIKey,omitempty"`
}

*

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

type SupportsPostBindings 

type SupportsPostBindings struct {
}

*

  • Helper interface that indicates an identity provider can be federated to using the HTTP POST method. *
  • @author Brian Pontarelli

type SystemConfiguration 

type SystemConfiguration struct {
	AuditLogConfiguration        AuditLogConfiguration           `json:"auditLogConfiguration,omitempty"`
	CorsConfiguration            CORSConfiguration               `json:"corsConfiguration,omitempty"`
	Data                         map[string]interface{}          `json:"data,omitempty"`
	EventLogConfiguration        EventLogConfiguration           `json:"eventLogConfiguration,omitempty"`
	InsertInstant                int64                           `json:"insertInstant,omitempty"`
	LastUpdateInstant            int64                           `json:"lastUpdateInstant,omitempty"`
	LoginRecordConfiguration     LoginRecordConfiguration        `json:"loginRecordConfiguration,omitempty"`
	ReportTimezone               string                          `json:"reportTimezone,omitempty"`
	TrustedProxyConfiguration    SystemTrustedProxyConfiguration `json:"trustedProxyConfiguration,omitempty"`
	UiConfiguration              UIConfiguration                 `json:"uiConfiguration,omitempty"`
	UsageDataConfiguration       UsageDataConfiguration          `json:"usageDataConfiguration,omitempty"`
	WebhookEventLogConfiguration WebhookEventLogConfiguration    `json:"webhookEventLogConfiguration,omitempty"`
}

*

  • @author Brian Pontarelli

type SystemConfigurationRequest 

type SystemConfigurationRequest struct {
	SystemConfiguration SystemConfiguration `json:"systemConfiguration,omitempty"`
}

*

  • Request for the system configuration API. *
  • @author Brian Pontarelli

type SystemConfigurationResponse 

type SystemConfigurationResponse struct {
	BaseHTTPResponse
	SystemConfiguration SystemConfiguration `json:"systemConfiguration,omitempty"`
}

*

  • Response for the system configuration API. *
  • @author Brian Pontarelli

func (*SystemConfigurationResponse) SetStatus 

func (b *SystemConfigurationResponse) SetStatus(status int)

type SystemLogsExportRequest 

type SystemLogsExportRequest struct {
	BaseExportRequest
	IncludeArchived bool `json:"includeArchived"`
	LastNBytes      int  `json:"lastNBytes,omitempty"`
}

*

  • @author Daniel DeGroff

type SystemTrustedProxyConfiguration 

type SystemTrustedProxyConfiguration struct {
	Trusted     []string                              `json:"trusted,omitempty"`
	TrustPolicy SystemTrustedProxyConfigurationPolicy `json:"trustPolicy,omitempty"`
}

*

  • @author Daniel DeGroff

type SystemTrustedProxyConfigurationPolicy 

type SystemTrustedProxyConfigurationPolicy string

*

  • @author Daniel DeGroff
const (
	SystemTrustedProxyConfigurationPolicy_All            SystemTrustedProxyConfigurationPolicy = "All"
	SystemTrustedProxyConfigurationPolicy_OnlyConfigured SystemTrustedProxyConfigurationPolicy = "OnlyConfigured"
)

func (SystemTrustedProxyConfigurationPolicy) String 

func (e SystemTrustedProxyConfigurationPolicy) String() string

type TOTPAlgorithm 

type TOTPAlgorithm string
const (
	TOTPAlgorithm_HmacSHA1   TOTPAlgorithm = "HmacSHA1"
	TOTPAlgorithm_HmacSHA256 TOTPAlgorithm = "HmacSHA256"
	TOTPAlgorithm_HmacSHA512 TOTPAlgorithm = "HmacSHA512"
)

func (TOTPAlgorithm) String 

func (e TOTPAlgorithm) String() string

type Templates 

type Templates struct {
	AccountEdit                               string `json:"accountEdit,omitempty"`
	AccountIndex                              string `json:"accountIndex,omitempty"`
	AccountTwoFactorDisable                   string `json:"accountTwoFactorDisable,omitempty"`
	AccountTwoFactorEnable                    string `json:"accountTwoFactorEnable,omitempty"`
	AccountTwoFactorIndex                     string `json:"accountTwoFactorIndex,omitempty"`
	AccountWebAuthnAdd                        string `json:"accountWebAuthnAdd,omitempty"`
	AccountWebAuthnDelete                     string `json:"accountWebAuthnDelete,omitempty"`
	AccountWebAuthnIndex                      string `json:"accountWebAuthnIndex,omitempty"`
	ConfirmationRequired                      string `json:"confirmationRequired,omitempty"`
	EmailComplete                             string `json:"emailComplete,omitempty"`
	EmailSend                                 string `json:"emailSend,omitempty"`
	EmailSent                                 string `json:"emailSent,omitempty"`
	EmailVerificationRequired                 string `json:"emailVerificationRequired,omitempty"`
	EmailVerify                               string `json:"emailVerify,omitempty"`
	Helpers                                   string `json:"helpers,omitempty"`
	Index                                     string `json:"index,omitempty"`
	Oauth2Authorize                           string `json:"oauth2Authorize,omitempty"`
	Oauth2AuthorizedNotRegistered             string `json:"oauth2AuthorizedNotRegistered,omitempty"`
	Oauth2ChildRegistrationNotAllowed         string `json:"oauth2ChildRegistrationNotAllowed,omitempty"`
	Oauth2ChildRegistrationNotAllowedComplete string `json:"oauth2ChildRegistrationNotAllowedComplete,omitempty"`
	Oauth2CompleteRegistration                string `json:"oauth2CompleteRegistration,omitempty"`
	Oauth2Consent                             string `json:"oauth2Consent,omitempty"`
	Oauth2Device                              string `json:"oauth2Device,omitempty"`
	Oauth2DeviceComplete                      string `json:"oauth2DeviceComplete,omitempty"`
	Oauth2Error                               string `json:"oauth2Error,omitempty"`
	Oauth2Logout                              string `json:"oauth2Logout,omitempty"`
	Oauth2Passwordless                        string `json:"oauth2Passwordless,omitempty"`
	Oauth2Register                            string `json:"oauth2Register,omitempty"`
	Oauth2StartIdPLink                        string `json:"oauth2StartIdPLink,omitempty"`
	Oauth2TwoFactor                           string `json:"oauth2TwoFactor,omitempty"`
	Oauth2TwoFactorEnable                     string `json:"oauth2TwoFactorEnable,omitempty"`
	Oauth2TwoFactorEnableComplete             string `json:"oauth2TwoFactorEnableComplete,omitempty"`
	Oauth2TwoFactorMethods                    string `json:"oauth2TwoFactorMethods,omitempty"`
	Oauth2Wait                                string `json:"oauth2Wait,omitempty"`
	Oauth2WebAuthn                            string `json:"oauth2WebAuthn,omitempty"`
	Oauth2WebAuthnReauth                      string `json:"oauth2WebAuthnReauth,omitempty"`
	Oauth2WebAuthnReauthEnable                string `json:"oauth2WebAuthnReauthEnable,omitempty"`
	PasswordChange                            string `json:"passwordChange,omitempty"`
	PasswordComplete                          string `json:"passwordComplete,omitempty"`
	PasswordForgot                            string `json:"passwordForgot,omitempty"`
	PasswordSent                              string `json:"passwordSent,omitempty"`
	RegistrationComplete                      string `json:"registrationComplete,omitempty"`
	RegistrationSend                          string `json:"registrationSend,omitempty"`
	RegistrationSent                          string `json:"registrationSent,omitempty"`
	RegistrationVerificationRequired          string `json:"registrationVerificationRequired,omitempty"`
	RegistrationVerify                        string `json:"registrationVerify,omitempty"`
	Samlv2Logout                              string `json:"samlv2Logout,omitempty"`
	Unauthorized                              string `json:"unauthorized,omitempty"`
}

type Tenant 

type Tenant struct {
	AccessControlConfiguration        TenantAccessControlConfiguration  `json:"accessControlConfiguration,omitempty"`
	CaptchaConfiguration              TenantCaptchaConfiguration        `json:"captchaConfiguration,omitempty"`
	Configured                        bool                              `json:"configured"`
	ConnectorPolicies                 []ConnectorPolicy                 `json:"connectorPolicies,omitempty"`
	Data                              map[string]interface{}            `json:"data,omitempty"`
	EmailConfiguration                EmailConfiguration                `json:"emailConfiguration,omitempty"`
	EventConfiguration                EventConfiguration                `json:"eventConfiguration,omitempty"`
	ExternalIdentifierConfiguration   ExternalIdentifierConfiguration   `json:"externalIdentifierConfiguration,omitempty"`
	FailedAuthenticationConfiguration FailedAuthenticationConfiguration `json:"failedAuthenticationConfiguration,omitempty"`
	FamilyConfiguration               FamilyConfiguration               `json:"familyConfiguration,omitempty"`
	FormConfiguration                 TenantFormConfiguration           `json:"formConfiguration,omitempty"`
	HttpSessionMaxInactiveInterval    int                               `json:"httpSessionMaxInactiveInterval,omitempty"`
	Id                                string                            `json:"id,omitempty"`
	InsertInstant                     int64                             `json:"insertInstant,omitempty"`
	Issuer                            string                            `json:"issuer,omitempty"`
	JwtConfiguration                  JWTConfiguration                  `json:"jwtConfiguration,omitempty"`
	LambdaConfiguration               TenantLambdaConfiguration         `json:"lambdaConfiguration,omitempty"`
	LastUpdateInstant                 int64                             `json:"lastUpdateInstant,omitempty"`
	LoginConfiguration                TenantLoginConfiguration          `json:"loginConfiguration,omitempty"`
	LogoutURL                         string                            `json:"logoutURL,omitempty"`
	MaximumPasswordAge                MaximumPasswordAge                `json:"maximumPasswordAge,omitempty"`
	MinimumPasswordAge                MinimumPasswordAge                `json:"minimumPasswordAge,omitempty"`
	MultiFactorConfiguration          TenantMultiFactorConfiguration    `json:"multiFactorConfiguration,omitempty"`
	Name                              string                            `json:"name,omitempty"`
	OauthConfiguration                TenantOAuth2Configuration         `json:"oauthConfiguration,omitempty"`
	PasswordEncryptionConfiguration   PasswordEncryptionConfiguration   `json:"passwordEncryptionConfiguration,omitempty"`
	PasswordValidationRules           PasswordValidationRules           `json:"passwordValidationRules,omitempty"`
	RateLimitConfiguration            TenantRateLimitConfiguration      `json:"rateLimitConfiguration,omitempty"`
	RegistrationConfiguration         TenantRegistrationConfiguration   `json:"registrationConfiguration,omitempty"`
	ScimServerConfiguration           TenantSCIMServerConfiguration     `json:"scimServerConfiguration,omitempty"`
	SsoConfiguration                  TenantSSOConfiguration            `json:"ssoConfiguration,omitempty"`
	State                             ObjectState                       `json:"state,omitempty"`
	ThemeId                           string                            `json:"themeId,omitempty"`
	UserDeletePolicy                  TenantUserDeletePolicy            `json:"userDeletePolicy,omitempty"`
	UsernameConfiguration             TenantUsernameConfiguration       `json:"usernameConfiguration,omitempty"`
	WebAuthnConfiguration             TenantWebAuthnConfiguration       `json:"webAuthnConfiguration,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantAccessControlConfiguration 

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

*

  • @author Brett Guy

type TenantCaptchaConfiguration 

type TenantCaptchaConfiguration struct {
	Enableable
	CaptchaMethod CaptchaMethod `json:"captchaMethod,omitempty"`
	SecretKey     string        `json:"secretKey,omitempty"`
	SiteKey       string        `json:"siteKey,omitempty"`
	Threshold     float64       `json:"threshold,omitempty"`
}

*

  • @author Brett Pontarelli

type TenantDeleteRequest 

type TenantDeleteRequest struct {
	BaseEventRequest
	Async bool `json:"async"`
}

*

  • Request for the Tenant API to delete a tenant rather than using the URL parameters. *
  • @author Brian Pontarelli

type TenantFormConfiguration 

type TenantFormConfiguration struct {
	AdminUserFormId string `json:"adminUserFormId,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantLambdaConfiguration 

type TenantLambdaConfiguration struct {
	LoginValidationId                     string `json:"loginValidationId,omitempty"`
	ScimEnterpriseUserRequestConverterId  string `json:"scimEnterpriseUserRequestConverterId,omitempty"`
	ScimEnterpriseUserResponseConverterId string `json:"scimEnterpriseUserResponseConverterId,omitempty"`
	ScimGroupRequestConverterId           string `json:"scimGroupRequestConverterId,omitempty"`
	ScimGroupResponseConverterId          string `json:"scimGroupResponseConverterId,omitempty"`
	ScimUserRequestConverterId            string `json:"scimUserRequestConverterId,omitempty"`
	ScimUserResponseConverterId           string `json:"scimUserResponseConverterId,omitempty"`
}

*

  • @author Rob Davis

type TenantLoginConfiguration 

type TenantLoginConfiguration struct {
	RequireAuthentication bool `json:"requireAuthentication"`
}

*

  • @author Daniel DeGroff

type TenantMultiFactorConfiguration 

type TenantMultiFactorConfiguration struct {
	Authenticator MultiFactorAuthenticatorMethod `json:"authenticator,omitempty"`
	Email         MultiFactorEmailMethod         `json:"email,omitempty"`
	LoginPolicy   MultiFactorLoginPolicy         `json:"loginPolicy,omitempty"`
	Sms           MultiFactorSMSMethod           `json:"sms,omitempty"`
}

*

  • @author Mikey Sleevi

type TenantOAuth2Configuration 

type TenantOAuth2Configuration struct {
	ClientCredentialsAccessTokenPopulateLambdaId string `json:"clientCredentialsAccessTokenPopulateLambdaId,omitempty"`
}

type TenantRateLimitConfiguration 

type TenantRateLimitConfiguration struct {
	FailedLogin                  RateLimitedRequestConfiguration `json:"failedLogin,omitempty"`
	ForgotPassword               RateLimitedRequestConfiguration `json:"forgotPassword,omitempty"`
	SendEmailVerification        RateLimitedRequestConfiguration `json:"sendEmailVerification,omitempty"`
	SendPasswordless             RateLimitedRequestConfiguration `json:"sendPasswordless,omitempty"`
	SendRegistrationVerification RateLimitedRequestConfiguration `json:"sendRegistrationVerification,omitempty"`
	SendTwoFactor                RateLimitedRequestConfiguration `json:"sendTwoFactor,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantRegistrationConfiguration 

type TenantRegistrationConfiguration struct {
	BlockedDomains []string `json:"blockedDomains,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantRequest 

type TenantRequest struct {
	BaseEventRequest
	SourceTenantId string   `json:"sourceTenantId,omitempty"`
	Tenant         Tenant   `json:"tenant,omitempty"`
	WebhookIds     []string `json:"webhookIds,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantResponse 

type TenantResponse struct {
	BaseHTTPResponse
	Tenant  Tenant   `json:"tenant,omitempty"`
	Tenants []Tenant `json:"tenants,omitempty"`
}

*

  • @author Daniel DeGroff

func (*TenantResponse) SetStatus 

func (b *TenantResponse) SetStatus(status int)

type TenantSCIMServerConfiguration 

type TenantSCIMServerConfiguration struct {
	Enableable
	ClientEntityTypeId string                 `json:"clientEntityTypeId,omitempty"`
	Schemas            map[string]interface{} `json:"schemas,omitempty"`
	ServerEntityTypeId string                 `json:"serverEntityTypeId,omitempty"`
}

*

  • @author Rob Davis

type TenantSSOConfiguration 

type TenantSSOConfiguration struct {
	AllowAccessTokenBootstrap      bool `json:"allowAccessTokenBootstrap"`
	DeviceTrustTimeToLiveInSeconds int  `json:"deviceTrustTimeToLiveInSeconds,omitempty"`
}

*

  • @author Brett Pontarelli

type TenantSearchCriteria 

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

*

  • Search criteria for Tenants *
  • @author Mark Manes

type TenantSearchRequest 

type TenantSearchRequest struct {
	Search TenantSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Tenants *
  • @author Mark Manes

type TenantSearchResponse 

type TenantSearchResponse struct {
	BaseHTTPResponse
	Tenants []Tenant `json:"tenants,omitempty"`
	Total   int64    `json:"total,omitempty"`
}

*

  • Tenant search response *
  • @author Mark Manes

func (*TenantSearchResponse) SetStatus 

func (b *TenantSearchResponse) SetStatus(status int)

type TenantUnverifiedConfiguration 

type TenantUnverifiedConfiguration struct {
	Email     UnverifiedBehavior            `json:"email,omitempty"`
	WhenGated RegistrationUnverifiedOptions `json:"whenGated,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantUserDeletePolicy 

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

*

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

type TenantUsernameConfiguration 

type TenantUsernameConfiguration struct {
	Unique UniqueUsernameConfiguration `json:"unique,omitempty"`
}

*

  • @author Daniel DeGroff

type TenantWebAuthnConfiguration 

type TenantWebAuthnConfiguration struct {
	Enableable
	BootstrapWorkflow        TenantWebAuthnWorkflowConfiguration `json:"bootstrapWorkflow,omitempty"`
	Debug                    bool                                `json:"debug"`
	ReauthenticationWorkflow TenantWebAuthnWorkflowConfiguration `json:"reauthenticationWorkflow,omitempty"`
	RelyingPartyId           string                              `json:"relyingPartyId,omitempty"`
	RelyingPartyName         string                              `json:"relyingPartyName,omitempty"`
}

*

  • Tenant-level configuration for WebAuthn *
  • @author Spencer Witt

type TenantWebAuthnWorkflowConfiguration 

type TenantWebAuthnWorkflowConfiguration struct {
	Enableable
	AuthenticatorAttachmentPreference AuthenticatorAttachmentPreference `json:"authenticatorAttachmentPreference,omitempty"`
	UserVerificationRequirement       UserVerificationRequirement       `json:"userVerificationRequirement,omitempty"`
}

*

  • @author Spencer Witt

type Tenantable 

type Tenantable struct {
}

*

  • @author Brian Pontarelli

type TestEvent 

type TestEvent struct {
	BaseEvent
	Message string `json:"message,omitempty"`
}

*

  • @author Daniel DeGroff

type Theme 

type Theme struct {
	Data              map[string]interface{} `json:"data,omitempty"`
	DefaultMessages   string                 `json:"defaultMessages,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	LocalizedMessages map[string]string      `json:"localizedMessages,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Stylesheet        string                 `json:"stylesheet,omitempty"`
	Templates         Templates              `json:"templates,omitempty"`
	Type              ThemeType              `json:"type,omitempty"`
	Variables         SimpleThemeVariables   `json:"variables,omitempty"`
}

*

  • @author Trevor Smith

type ThemeRequest 

type ThemeRequest struct {
	SourceThemeId string `json:"sourceThemeId,omitempty"`
	Theme         Theme  `json:"theme,omitempty"`
}

*

  • Theme API request object. *
  • @author Trevor Smith

type ThemeResponse 

type ThemeResponse struct {
	BaseHTTPResponse
	Theme  Theme   `json:"theme,omitempty"`
	Themes []Theme `json:"themes,omitempty"`
}

*

  • Theme API response object. *
  • @author Trevor Smith

func (*ThemeResponse) SetStatus 

func (b *ThemeResponse) SetStatus(status int)

type ThemeSearchCriteria 

type ThemeSearchCriteria struct {
	BaseSearchCriteria
	Name string    `json:"name,omitempty"`
	Type ThemeType `json:"type,omitempty"`
}

*

  • Search criteria for themes *
  • @author Mark Manes

type ThemeSearchRequest 

type ThemeSearchRequest struct {
	Search ThemeSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for Themes. *
  • @author Mark Manes

type ThemeSearchResponse 

type ThemeSearchResponse struct {
	BaseHTTPResponse
	Themes []Theme `json:"themes,omitempty"`
	Total  int64   `json:"total,omitempty"`
}

*

  • Search response for Themes *
  • @author Mark Manes

func (*ThemeSearchResponse) SetStatus 

func (b *ThemeSearchResponse) SetStatus(status int)

type ThemeType 

type ThemeType string
const (
	ThemeType_Advanced ThemeType = "advanced"
	ThemeType_Simple   ThemeType = "simple"
)

func (ThemeType) String 

func (e ThemeType) String() string

type TimeBasedDeletePolicy 

type TimeBasedDeletePolicy struct {
	Enableable
	EnabledInstant       int64 `json:"enabledInstant,omitempty"`
	NumberOfDaysToRetain int   `json:"numberOfDaysToRetain,omitempty"`
}

*

  • A policy for deleting Users based upon some external criteria. *
  • @author Trevor Smith

type TokenType 

type TokenType string

* 

const (
	TokenType_Bearer TokenType = "Bearer"
	TokenType_MAC    TokenType = "MAC"
)

func (TokenType) String 

func (e TokenType) String() string

type Totals 

type Totals struct {
	Logins             int64 `json:"logins,omitempty"`
	Registrations      int64 `json:"registrations,omitempty"`
	TotalRegistrations int64 `json:"totalRegistrations,omitempty"`
}

type TotalsReportResponse 

type TotalsReportResponse struct {
	BaseHTTPResponse
	ApplicationTotals        map[string]Totals `json:"applicationTotals,omitempty"`
	GlobalRegistrations      int64             `json:"globalRegistrations,omitempty"`
	TotalGlobalRegistrations int64             `json:"totalGlobalRegistrations,omitempty"`
}

*

  • The response from the total report. This report stores the total numbers for each application. *
  • @author Brian Pontarelli

func (*TotalsReportResponse) SetStatus 

func (b *TotalsReportResponse) SetStatus(status int)

type TransactionType 

type TransactionType string

*

  • The transaction types for Webhooks and other event systems within FusionAuth. *
  • @author Brian Pontarelli
const (
	TransactionType_None             TransactionType = "None"
	TransactionType_Any              TransactionType = "Any"
	TransactionType_SimpleMajority   TransactionType = "SimpleMajority"
	TransactionType_SuperMajority    TransactionType = "SuperMajority"
	TransactionType_AbsoluteMajority TransactionType = "AbsoluteMajority"
)

func (TransactionType) String 

func (e TransactionType) String() string

type TwilioMessengerConfiguration 

type TwilioMessengerConfiguration struct {
	BaseMessengerConfiguration
	AccountSID          string `json:"accountSID,omitempty"`
	AuthToken           string `json:"authToken,omitempty"`
	FromPhoneNumber     string `json:"fromPhoneNumber,omitempty"`
	MessagingServiceSid string `json:"messagingServiceSid,omitempty"`
	Url                 string `json:"url,omitempty"`
}

*

  • @author Brett Guy

type TwitchApplicationConfiguration 

type TwitchApplicationConfiguration 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 TwitchIdentityProvider 

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

*

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

type TwitterApplicationConfiguration 

type TwitterApplicationConfiguration struct {
	BaseIdentityProviderApplicationConfiguration
	ButtonText     string `json:"buttonText,omitempty"`
	ConsumerKey    string `json:"consumerKey,omitempty"`
	ConsumerSecret string `json:"consumerSecret,omitempty"`
}

*

  • @author Daniel DeGroff

type TwitterIdentityProvider 

type TwitterIdentityProvider struct {
	BaseIdentityProvider
	ButtonText     string `json:"buttonText,omitempty"`
	ConsumerKey    string `json:"consumerKey,omitempty"`
	ConsumerSecret string `json:"consumerSecret,omitempty"`
}

*

  • Twitter social login provider. *
  • @author Daniel DeGroff

type TwoFactorDisableRequest 

type TwoFactorDisableRequest struct {
	BaseEventRequest
	ApplicationId string `json:"applicationId,omitempty"`
	Code          string `json:"code,omitempty"`
	MethodId      string `json:"methodId,omitempty"`
}

*

  • @author Brian Pontarelli

type TwoFactorEnableDisableSendRequest 

type TwoFactorEnableDisableSendRequest struct {
	Email       string `json:"email,omitempty"`
	Method      string `json:"method,omitempty"`
	MethodId    string `json:"methodId,omitempty"`
	MobilePhone string `json:"mobilePhone,omitempty"`
}

*

  • @author Daniel DeGroff

type TwoFactorLoginRequest 

type TwoFactorLoginRequest struct {
	BaseLoginRequest
	Code          string `json:"code,omitempty"`
	TrustComputer bool   `json:"trustComputer"`
	TwoFactorId   string `json:"twoFactorId,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • @author Daniel DeGroff

type TwoFactorMethod 

type TwoFactorMethod struct {
	Authenticator AuthenticatorConfiguration `json:"authenticator,omitempty"`
	Email         string                     `json:"email,omitempty"`
	Id            string                     `json:"id,omitempty"`
	LastUsed      bool                       `json:"lastUsed"`
	Method        string                     `json:"method,omitempty"`
	MobilePhone   string                     `json:"mobilePhone,omitempty"`
	Secret        string                     `json:"secret,omitempty"`
}

*

  • @author Daniel DeGroff

type TwoFactorRecoveryCodeResponse 

type TwoFactorRecoveryCodeResponse struct {
	BaseHTTPResponse
	RecoveryCodes []string `json:"recoveryCodes,omitempty"`
}

*

  • @author Daniel DeGroff

func (*TwoFactorRecoveryCodeResponse) SetStatus 

func (b *TwoFactorRecoveryCodeResponse) SetStatus(status int)

type TwoFactorRequest 

type TwoFactorRequest struct {
	BaseEventRequest
	ApplicationId       string `json:"applicationId,omitempty"`
	AuthenticatorId     string `json:"authenticatorId,omitempty"`
	Code                string `json:"code,omitempty"`
	Email               string `json:"email,omitempty"`
	Method              string `json:"method,omitempty"`
	MobilePhone         string `json:"mobilePhone,omitempty"`
	Secret              string `json:"secret,omitempty"`
	SecretBase32Encoded string `json:"secretBase32Encoded,omitempty"`
	TwoFactorId         string `json:"twoFactorId,omitempty"`
}

*

  • @author Brian Pontarelli

type TwoFactorResponse 

type TwoFactorResponse struct {
	BaseHTTPResponse
	Code          string   `json:"code,omitempty"`
	RecoveryCodes []string `json:"recoveryCodes,omitempty"`
}

*

  • @author Daniel DeGroff

func (*TwoFactorResponse) SetStatus 

func (b *TwoFactorResponse) SetStatus(status int)

type TwoFactorSendRequest 

type TwoFactorSendRequest struct {
	ApplicationId string `json:"applicationId,omitempty"`
	Email         string `json:"email,omitempty"`
	Method        string `json:"method,omitempty"`
	MethodId      string `json:"methodId,omitempty"`
	MobilePhone   string `json:"mobilePhone,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • @author Daniel DeGroff

type TwoFactorStartRequest 

type TwoFactorStartRequest struct {
	ApplicationId  string                 `json:"applicationId,omitempty"`
	Code           string                 `json:"code,omitempty"`
	LoginId        string                 `json:"loginId,omitempty"`
	State          map[string]interface{} `json:"state,omitempty"`
	TrustChallenge string                 `json:"trustChallenge,omitempty"`
	UserId         string                 `json:"userId,omitempty"`
}

*

  • @author Brett Guy

type TwoFactorStartResponse 

type TwoFactorStartResponse struct {
	BaseHTTPResponse
	Code        string            `json:"code,omitempty"`
	Methods     []TwoFactorMethod `json:"methods,omitempty"`
	TwoFactorId string            `json:"twoFactorId,omitempty"`
}

*

  • @author Daniel DeGroff

func (*TwoFactorStartResponse) SetStatus 

func (b *TwoFactorStartResponse) SetStatus(status int)

type TwoFactorStatusResponse 

type TwoFactorStatusResponse struct {
	BaseHTTPResponse
	Trusts           []TwoFactorTrust `json:"trusts,omitempty"`
	TwoFactorTrustId string           `json:"twoFactorTrustId,omitempty"`
}

*

  • @author Daniel DeGroff

func (*TwoFactorStatusResponse) SetStatus 

func (b *TwoFactorStatusResponse) SetStatus(status int)

type TwoFactorTrust 

type TwoFactorTrust struct {
	ApplicationId string `json:"applicationId,omitempty"`
	Expiration    int64  `json:"expiration,omitempty"`
	StartInstant  int64  `json:"startInstant,omitempty"`
}

type UIConfiguration 

type UIConfiguration struct {
	HeaderColor   string `json:"headerColor,omitempty"`
	LogoURL       string `json:"logoURL,omitempty"`
	MenuFontColor string `json:"menuFontColor,omitempty"`
}

type UniqueUsernameConfiguration 

type UniqueUsernameConfiguration struct {
	Enableable
	NumberOfDigits int                    `json:"numberOfDigits,omitempty"`
	Separator      string                 `json:"separator,omitempty"`
	Strategy       UniqueUsernameStrategy `json:"strategy,omitempty"`
}

type UniqueUsernameStrategy 

type UniqueUsernameStrategy string
const (
	UniqueUsernameStrategy_Always      UniqueUsernameStrategy = "Always"
	UniqueUsernameStrategy_OnCollision UniqueUsernameStrategy = "OnCollision"
)

func (UniqueUsernameStrategy) String 

func (e UniqueUsernameStrategy) String() string

type UnknownScopePolicy 

type UnknownScopePolicy string

*

  • Policy for handling unknown OAuth scopes in the request *
  • @author Spencer Witt
const (
	UnknownScopePolicy_Allow  UnknownScopePolicy = "Allow"
	UnknownScopePolicy_Remove UnknownScopePolicy = "Remove"
	UnknownScopePolicy_Reject UnknownScopePolicy = "Reject"
)

func (UnknownScopePolicy) String 

func (e UnknownScopePolicy) String() string

type UnverifiedBehavior 

type UnverifiedBehavior string

*

  • @author Daniel DeGroff
const (
	UnverifiedBehavior_Allow UnverifiedBehavior = "Allow"
	UnverifiedBehavior_Gated UnverifiedBehavior = "Gated"
)

func (UnverifiedBehavior) String 

func (e UnverifiedBehavior) String() string

type UsageDataConfiguration 

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

*

  • Config for Usage Data / Stats *
  • @author Lyle Schemmerling

type User 

type User struct {
	SecureIdentity
	Active             bool                       `json:"active"`
	BirthDate          string                     `json:"birthDate,omitempty"`
	CleanSpeakId       string                     `json:"cleanSpeakId,omitempty"`
	Data               map[string]interface{}     `json:"data,omitempty"`
	Email              string                     `json:"email,omitempty"`
	Expiry             int64                      `json:"expiry,omitempty"`
	FirstName          string                     `json:"firstName,omitempty"`
	FullName           string                     `json:"fullName,omitempty"`
	ImageUrl           string                     `json:"imageUrl,omitempty"`
	InsertInstant      int64                      `json:"insertInstant,omitempty"`
	LastName           string                     `json:"lastName,omitempty"`
	LastUpdateInstant  int64                      `json:"lastUpdateInstant,omitempty"`
	Memberships        []GroupMember              `json:"memberships,omitempty"`
	MiddleName         string                     `json:"middleName,omitempty"`
	MobilePhone        string                     `json:"mobilePhone,omitempty"`
	ParentEmail        string                     `json:"parentEmail,omitempty"`
	PreferredLanguages []string                   `json:"preferredLanguages,omitempty"`
	Registrations      []UserRegistration         `json:"registrations,omitempty"`
	TenantId           string                     `json:"tenantId,omitempty"`
	Timezone           string                     `json:"timezone,omitempty"`
	TwoFactor          UserTwoFactorConfiguration `json:"twoFactor,omitempty"`
}

*

  • The global view of a User. This object contains all global information about the user including birthdate, registration information
  • preferred languages, global attributes, etc. *
  • @author Seth Musselman

type UserAction 

type UserAction struct {
	Active                   bool               `json:"active"`
	CancelEmailTemplateId    string             `json:"cancelEmailTemplateId,omitempty"`
	EndEmailTemplateId       string             `json:"endEmailTemplateId,omitempty"`
	Id                       string             `json:"id,omitempty"`
	IncludeEmailInEventJSON  bool               `json:"includeEmailInEventJSON"`
	InsertInstant            int64              `json:"insertInstant,omitempty"`
	LastUpdateInstant        int64              `json:"lastUpdateInstant,omitempty"`
	LocalizedNames           map[string]string  `json:"localizedNames,omitempty"`
	ModifyEmailTemplateId    string             `json:"modifyEmailTemplateId,omitempty"`
	Name                     string             `json:"name,omitempty"`
	Options                  []UserActionOption `json:"options,omitempty"`
	PreventLogin             bool               `json:"preventLogin"`
	SendEndEvent             bool               `json:"sendEndEvent"`
	StartEmailTemplateId     string             `json:"startEmailTemplateId,omitempty"`
	Temporal                 bool               `json:"temporal"`
	TransactionType          TransactionType    `json:"transactionType,omitempty"`
	UserEmailingEnabled      bool               `json:"userEmailingEnabled"`
	UserNotificationsEnabled bool               `json:"userNotificationsEnabled"`
}

*

  • An action that can be executed on a user (discipline or reward potentially). *
  • @author Brian Pontarelli

type UserActionEvent 

type UserActionEvent struct {
	BaseEvent
	Action            string          `json:"action,omitempty"`
	ActioneeUserId    string          `json:"actioneeUserId,omitempty"`
	ActionerUserId    string          `json:"actionerUserId,omitempty"`
	ActionId          string          `json:"actionId,omitempty"`
	ApplicationIds    []string        `json:"applicationIds,omitempty"`
	Comment           string          `json:"comment,omitempty"`
	Email             Email           `json:"email,omitempty"`
	EmailedUser       bool            `json:"emailedUser"`
	Expiry            int64           `json:"expiry,omitempty"`
	LocalizedAction   string          `json:"localizedAction,omitempty"`
	LocalizedDuration string          `json:"localizedDuration,omitempty"`
	LocalizedOption   string          `json:"localizedOption,omitempty"`
	LocalizedReason   string          `json:"localizedReason,omitempty"`
	NotifyUser        bool            `json:"notifyUser"`
	Option            string          `json:"option,omitempty"`
	Phase             UserActionPhase `json:"phase,omitempty"`
	Reason            string          `json:"reason,omitempty"`
	ReasonCode        string          `json:"reasonCode,omitempty"`
}

*

  • Models the user action Event. *
  • @author Brian Pontarelli

type UserActionLog 

type UserActionLog struct {
	ActioneeUserId  string     `json:"actioneeUserId,omitempty"`
	ActionerUserId  string     `json:"actionerUserId,omitempty"`
	ApplicationIds  []string   `json:"applicationIds,omitempty"`
	Comment         string     `json:"comment,omitempty"`
	EmailUserOnEnd  bool       `json:"emailUserOnEnd"`
	EndEventSent    bool       `json:"endEventSent"`
	Expiry          int64      `json:"expiry,omitempty"`
	History         LogHistory `json:"history,omitempty"`
	Id              string     `json:"id,omitempty"`
	InsertInstant   int64      `json:"insertInstant,omitempty"`
	LocalizedName   string     `json:"localizedName,omitempty"`
	LocalizedOption string     `json:"localizedOption,omitempty"`
	LocalizedReason string     `json:"localizedReason,omitempty"`
	Name            string     `json:"name,omitempty"`
	NotifyUserOnEnd bool       `json:"notifyUserOnEnd"`
	Option          string     `json:"option,omitempty"`
	Reason          string     `json:"reason,omitempty"`
	ReasonCode      string     `json:"reasonCode,omitempty"`
	UserActionId    string     `json:"userActionId,omitempty"`
}

*

  • A log for an action that was taken on a User. *
  • @author Brian Pontarelli

type UserActionOption 

type UserActionOption struct {
	LocalizedNames map[string]string `json:"localizedNames,omitempty"`
	Name           string            `json:"name,omitempty"`
}

*

  • Models content user action options. *
  • @author Brian Pontarelli

type UserActionPhase 

type UserActionPhase string

*

  • The phases of a time-based user action. *
  • @author Brian Pontarelli
const (
	UserActionPhase_Start  UserActionPhase = "start"
	UserActionPhase_Modify UserActionPhase = "modify"
	UserActionPhase_Cancel UserActionPhase = "cancel"
	UserActionPhase_End    UserActionPhase = "end"
)

func (UserActionPhase) String 

func (e UserActionPhase) String() string

type UserActionReason 

type UserActionReason struct {
	Code              string            `json:"code,omitempty"`
	Id                string            `json:"id,omitempty"`
	InsertInstant     int64             `json:"insertInstant,omitempty"`
	LastUpdateInstant int64             `json:"lastUpdateInstant,omitempty"`
	LocalizedTexts    map[string]string `json:"localizedTexts,omitempty"`
	Text              string            `json:"text,omitempty"`
}

*

  • Models action reasons. *
  • @author Brian Pontarelli

type UserActionReasonRequest 

type UserActionReasonRequest struct {
	UserActionReason UserActionReason `json:"userActionReason,omitempty"`
}

*

  • User Action Reason API request object. *
  • @author Brian Pontarelli

type UserActionReasonResponse 

type UserActionReasonResponse struct {
	BaseHTTPResponse
	UserActionReason  UserActionReason   `json:"userActionReason,omitempty"`
	UserActionReasons []UserActionReason `json:"userActionReasons,omitempty"`
}

*

  • User Action Reason API response object. *
  • @author Brian Pontarelli

func (*UserActionReasonResponse) SetStatus 

func (b *UserActionReasonResponse) SetStatus(status int)

type UserActionRequest 

type UserActionRequest struct {
	UserAction UserAction `json:"userAction,omitempty"`
}

*

  • User Action API request object. *
  • @author Brian Pontarelli

type UserActionResponse 

type UserActionResponse struct {
	BaseHTTPResponse
	UserAction  UserAction   `json:"userAction,omitempty"`
	UserActions []UserAction `json:"userActions,omitempty"`
}

*

  • User Action API response object. *
  • @author Brian Pontarelli

func (*UserActionResponse) SetStatus 

func (b *UserActionResponse) SetStatus(status int)

type UserBulkCreateEvent 

type UserBulkCreateEvent struct {
	BaseEvent
	Users []User `json:"users,omitempty"`
}

*

  • Models the User Bulk Create Event. *
  • @author Brian Pontarelli

type UserComment 

type UserComment struct {
	Comment       string `json:"comment,omitempty"`
	CommenterId   string `json:"commenterId,omitempty"`
	Id            string `json:"id,omitempty"`
	InsertInstant int64  `json:"insertInstant,omitempty"`
	UserId        string `json:"userId,omitempty"`
}

*

  • A log for an event that happened to a User. *
  • @author Brian Pontarelli

type UserCommentRequest 

type UserCommentRequest struct {
	UserComment UserComment `json:"userComment,omitempty"`
}

*

  • @author Seth Musselman

type UserCommentResponse 

type UserCommentResponse struct {
	BaseHTTPResponse
	UserComment  UserComment   `json:"userComment,omitempty"`
	UserComments []UserComment `json:"userComments,omitempty"`
}

*

  • User Comment Response *
  • @author Seth Musselman

func (*UserCommentResponse) SetStatus 

func (b *UserCommentResponse) SetStatus(status int)

type UserCommentSearchCriteria 

type UserCommentSearchCriteria struct {
	BaseSearchCriteria
	Comment     string `json:"comment,omitempty"`
	CommenterId string `json:"commenterId,omitempty"`
	TenantId    string `json:"tenantId,omitempty"`
	UserId      string `json:"userId,omitempty"`
}

*

  • Search criteria for user comments. *
  • @author Spencer Witt

type UserCommentSearchRequest 

type UserCommentSearchRequest struct {
	Search UserCommentSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for user comments *
  • @author Spencer Witt

type UserCommentSearchResponse 

type UserCommentSearchResponse struct {
	BaseHTTPResponse
	Total        int64         `json:"total,omitempty"`
	UserComments []UserComment `json:"userComments,omitempty"`
}

*

  • User comment search response *
  • @author Spencer Witt

func (*UserCommentSearchResponse) SetStatus 

func (b *UserCommentSearchResponse) SetStatus(status int)

type UserConsent 

type UserConsent struct {
	Consent           Consent                `json:"consent,omitempty"`
	ConsentId         string                 `json:"consentId,omitempty"`
	Data              map[string]interface{} `json:"data,omitempty"`
	GiverUserId       string                 `json:"giverUserId,omitempty"`
	Id                string                 `json:"id,omitempty"`
	InsertInstant     int64                  `json:"insertInstant,omitempty"`
	LastUpdateInstant int64                  `json:"lastUpdateInstant,omitempty"`
	Status            ConsentStatus          `json:"status,omitempty"`
	UserId            string                 `json:"userId,omitempty"`
	Values            []string               `json:"values,omitempty"`
}

*

  • Models a User consent. *
  • @author Daniel DeGroff

type UserConsentRequest 

type UserConsentRequest struct {
	UserConsent UserConsent `json:"userConsent,omitempty"`
}

*

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

type UserConsentResponse 

type UserConsentResponse struct {
	BaseHTTPResponse
	UserConsent  UserConsent   `json:"userConsent,omitempty"`
	UserConsents []UserConsent `json:"userConsents,omitempty"`
}

*

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

func (*UserConsentResponse) SetStatus 

func (b *UserConsentResponse) SetStatus(status int)

type UserCreateCompleteEvent 

type UserCreateCompleteEvent struct {
	BaseUserEvent
}

*

  • Models the User Created Event.
  • <p>
  • This is different than the user.create event in that it will be sent after the user has been created. This event cannot be made transactional. *
  • @author Daniel DeGroff

type UserCreateEvent 

type UserCreateEvent struct {
	BaseUserEvent
}

*

  • Models the User Create Event. *
  • @author Brian Pontarelli

type UserDeactivateEvent 

type UserDeactivateEvent struct {
	BaseUserEvent
}

*

  • Models the User Deactivate Event. *
  • @author Brian Pontarelli

type UserDeleteCompleteEvent 

type UserDeleteCompleteEvent struct {
	BaseUserEvent
}

*

  • Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
  • delete).
  • <p>
  • This is different than user.delete because it is sent after the tx is committed, this cannot be transactional. *
  • @author Daniel DeGroff

type UserDeleteEvent 

type UserDeleteEvent struct {
	BaseUserEvent
}

*

  • Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
  • delete). *
  • @author Brian Pontarelli

type UserDeleteRequest 

type UserDeleteRequest struct {
	BaseEventRequest
	DryRun      bool     `json:"dryRun"`
	HardDelete  bool     `json:"hardDelete"`
	Limit       int      `json:"limit,omitempty"`
	Query       string   `json:"query,omitempty"`
	QueryString string   `json:"queryString,omitempty"`
	UserIds     []string `json:"userIds,omitempty"`
}

*

  • User API delete request object. *
  • @author Daniel DeGroff

type UserDeleteResponse 

type UserDeleteResponse struct {
	BaseHTTPResponse
	DryRun     bool     `json:"dryRun"`
	HardDelete bool     `json:"hardDelete"`
	Total      int      `json:"total,omitempty"`
	UserIds    []string `json:"userIds,omitempty"`
}

*

  • User API bulk response object. *
  • @author Trevor Smith

func (*UserDeleteResponse) SetStatus 

func (b *UserDeleteResponse) SetStatus(status int)

type UserDeleteSingleRequest 

type UserDeleteSingleRequest struct {
	BaseEventRequest
	HardDelete bool `json:"hardDelete"`
}

*

  • User API delete request object for a single user. *
  • @author Brian Pontarelli

type UserEmailUpdateEvent 

type UserEmailUpdateEvent struct {
	BaseUserEvent
	PreviousEmail string `json:"previousEmail,omitempty"`
}

*

  • Models an event where a user's email is updated outside of a forgot / change password workflow. *
  • @author Daniel DeGroff

type UserEmailVerifiedEvent 

type UserEmailVerifiedEvent struct {
	BaseUserEvent
}

*

  • Models the User Email Verify Event. *
  • @author Trevor Smith

type UserIdentityProviderLinkEvent 

type UserIdentityProviderLinkEvent struct {
	BaseUserEvent
	IdentityProviderLink IdentityProviderLink `json:"identityProviderLink,omitempty"`
}

*

  • Models the User Identity Provider Link Event. *
  • @author Rob Davis

type UserIdentityProviderUnlinkEvent 

type UserIdentityProviderUnlinkEvent struct {
	BaseUserEvent
	IdentityProviderLink IdentityProviderLink `json:"identityProviderLink,omitempty"`
}

*

  • Models the User Identity Provider Unlink Event. *
  • @author Rob Davis

type UserLoginFailedEvent 

type UserLoginFailedEvent struct {
	BaseUserEvent
	ApplicationId      string                `json:"applicationId,omitempty"`
	AuthenticationType string                `json:"authenticationType,omitempty"`
	IpAddress          string                `json:"ipAddress,omitempty"`
	Reason             UserLoginFailedReason `json:"reason,omitempty"`
}

*

  • Models the User Login Failed Event. *
  • @author Daniel DeGroff

type UserLoginFailedReason 

type UserLoginFailedReason struct {
	Code         string `json:"code,omitempty"`
	LambdaId     string `json:"lambdaId,omitempty"`
	LambdaResult Errors `json:"lambdaResult,omitempty"`
}

*

  • The reason for the login failure. *
  • @author Daniel DeGroff

type UserLoginFailedReasonCode 

type UserLoginFailedReasonCode struct {
}

*

  • User login failed reason codes.

type UserLoginIdDuplicateOnCreateEvent 

type UserLoginIdDuplicateOnCreateEvent struct {
	BaseUserEvent
	DuplicateEmail    string `json:"duplicateEmail,omitempty"`
	DuplicateUsername string `json:"duplicateUsername,omitempty"`
	Existing          User   `json:"existing,omitempty"`
}

*

  • Models an event where a user is being created with an "in-use" login Id (email or username). *
  • @author Daniel DeGroff

type UserLoginIdDuplicateOnUpdateEvent 

type UserLoginIdDuplicateOnUpdateEvent struct {
	UserLoginIdDuplicateOnCreateEvent
}

*

  • Models an event where a user is being updated and tries to use an "in-use" login Id (email or username). *
  • @author Daniel DeGroff

type UserLoginNewDeviceEvent 

type UserLoginNewDeviceEvent struct {
	UserLoginSuccessEvent
}

*

  • Models the User Login event for a new device (un-recognized) *
  • @author Daniel DeGroff

type UserLoginSuccessEvent 

type UserLoginSuccessEvent struct {
	BaseUserEvent
	ApplicationId        string `json:"applicationId,omitempty"`
	AuthenticationType   string `json:"authenticationType,omitempty"`
	ConnectorId          string `json:"connectorId,omitempty"`
	IdentityProviderId   string `json:"identityProviderId,omitempty"`
	IdentityProviderName string `json:"identityProviderName,omitempty"`
	IpAddress            string `json:"ipAddress,omitempty"`
}

*

  • Models the User Login Success Event. *
  • @author Daniel DeGroff

type UserLoginSuspiciousEvent 

type UserLoginSuspiciousEvent struct {
	UserLoginSuccessEvent
	ThreatsDetected []AuthenticationThreats `json:"threatsDetected,omitempty"`
}

*

  • Models the User Login event that is suspicious. *
  • @author Daniel DeGroff

type UserPasswordBreachEvent 

type UserPasswordBreachEvent struct {
	BaseUserEvent
}

*

  • Models the User Password Breach Event. *
  • @author Matthew Altman

type UserPasswordResetSendEvent 

type UserPasswordResetSendEvent struct {
	BaseUserEvent
}

*

  • Models the User Password Reset Send Event. *
  • @author Daniel DeGroff

type UserPasswordResetStartEvent 

type UserPasswordResetStartEvent struct {
	BaseUserEvent
}

*

  • Models the User Password Reset Start Event. *
  • @author Daniel DeGroff

type UserPasswordResetSuccessEvent 

type UserPasswordResetSuccessEvent struct {
	BaseUserEvent
}

*

  • Models the User Password Reset Success Event. *
  • @author Daniel DeGroff

type UserPasswordUpdateEvent 

type UserPasswordUpdateEvent struct {
	BaseUserEvent
}

*

  • Models the User Password Update Event. *
  • @author Daniel DeGroff

type UserReactivateEvent 

type UserReactivateEvent struct {
	BaseUserEvent
}

*

  • Models the User Reactivate Event. *
  • @author Brian Pontarelli

type UserRegistration 

type UserRegistration struct {
	ApplicationId       string                 `json:"applicationId,omitempty"`
	AuthenticationToken string                 `json:"authenticationToken,omitempty"`
	CleanSpeakId        string                 `json:"cleanSpeakId,omitempty"`
	Data                map[string]interface{} `json:"data,omitempty"`
	Id                  string                 `json:"id,omitempty"`
	InsertInstant       int64                  `json:"insertInstant,omitempty"`
	LastLoginInstant    int64                  `json:"lastLoginInstant,omitempty"`
	LastUpdateInstant   int64                  `json:"lastUpdateInstant,omitempty"`
	PreferredLanguages  []string               `json:"preferredLanguages,omitempty"`
	Roles               []string               `json:"roles,omitempty"`
	Timezone            string                 `json:"timezone,omitempty"`
	Tokens              map[string]string      `json:"tokens,omitempty"`
	Username            string                 `json:"username,omitempty"`
	UsernameStatus      ContentStatus          `json:"usernameStatus,omitempty"`
	Verified            bool                   `json:"verified"`
	VerifiedInstant     int64                  `json:"verifiedInstant,omitempty"`
}

*

  • User registration information for a single application. *
  • @author Brian Pontarelli

type UserRegistrationCreateCompleteEvent 

type UserRegistrationCreateCompleteEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Created Registration Event.
  • <p>
  • This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
  • transactional. *
  • @author Daniel DeGroff

type UserRegistrationCreateEvent 

type UserRegistrationCreateEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Create Registration Event. *
  • @author Daniel DeGroff

type UserRegistrationDeleteCompleteEvent 

type UserRegistrationDeleteCompleteEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Deleted Registration Event.
  • <p>
  • This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional. *
  • @author Daniel DeGroff

type UserRegistrationDeleteEvent 

type UserRegistrationDeleteEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Delete Registration Event. *
  • @author Daniel DeGroff

type UserRegistrationUpdateCompleteEvent 

type UserRegistrationUpdateCompleteEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Original      UserRegistration `json:"original,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Update Registration Event.
  • <p>
  • This is different than user.registration.update in that it is sent after this event completes, this cannot be transactional. *
  • @author Daniel DeGroff

type UserRegistrationUpdateEvent 

type UserRegistrationUpdateEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Original      UserRegistration `json:"original,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Update Registration Event. *
  • @author Daniel DeGroff

type UserRegistrationVerifiedEvent 

type UserRegistrationVerifiedEvent struct {
	BaseUserEvent
	ApplicationId string           `json:"applicationId,omitempty"`
	Registration  UserRegistration `json:"registration,omitempty"`
}

*

  • Models the User Registration Verified Event. *
  • @author Trevor Smith

type UserRequest 

type UserRequest struct {
	BaseEventRequest
	ApplicationId        string `json:"applicationId,omitempty"`
	CurrentPassword      string `json:"currentPassword,omitempty"`
	DisableDomainBlock   bool   `json:"disableDomainBlock"`
	SendSetPasswordEmail bool   `json:"sendSetPasswordEmail"`
	SkipVerification     bool   `json:"skipVerification"`
	User                 User   `json:"user,omitempty"`
}

*

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

type UserResponse 

type UserResponse struct {
	BaseHTTPResponse
	EmailVerificationId                  string            `json:"emailVerificationId,omitempty"`
	EmailVerificationOneTimeCode         string            `json:"emailVerificationOneTimeCode,omitempty"`
	RegistrationVerificationIds          map[string]string `json:"registrationVerificationIds,omitempty"`
	RegistrationVerificationOneTimeCodes map[string]string `json:"registrationVerificationOneTimeCodes,omitempty"`
	Token                                string            `json:"token,omitempty"`
	TokenExpirationInstant               int64             `json:"tokenExpirationInstant,omitempty"`
	User                                 User              `json:"user,omitempty"`
}

*

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

func (*UserResponse) SetStatus 

func (b *UserResponse) SetStatus(status int)

type UserSearchCriteria 

type UserSearchCriteria struct {
	BaseElasticSearchCriteria
}

*

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

type UserState 

type UserState string

*

  • @author Daniel DeGroff
const (
	UserState_Authenticated                        UserState = "Authenticated"
	UserState_AuthenticatedNotRegistered           UserState = "AuthenticatedNotRegistered"
	UserState_AuthenticatedNotVerified             UserState = "AuthenticatedNotVerified"
	UserState_AuthenticatedRegistrationNotVerified UserState = "AuthenticatedRegistrationNotVerified"
)

func (UserState) String 

func (e UserState) String() string

type UserTwoFactorConfiguration 

type UserTwoFactorConfiguration struct {
	Methods       []TwoFactorMethod `json:"methods,omitempty"`
	RecoveryCodes []string          `json:"recoveryCodes,omitempty"`
}

*

  • @author Daniel DeGroff

type UserTwoFactorMethodAddEvent 

type UserTwoFactorMethodAddEvent struct {
	BaseUserEvent
	Method TwoFactorMethod `json:"method,omitempty"`
}

*

  • Model a user event when a two-factor method has been removed. *
  • @author Daniel DeGroff

type UserTwoFactorMethodRemoveEvent 

type UserTwoFactorMethodRemoveEvent struct {
	BaseUserEvent
	Method TwoFactorMethod `json:"method,omitempty"`
}

*

  • Model a user event when a two-factor method has been added. *
  • @author Daniel DeGroff

type UserUpdateCompleteEvent 

type UserUpdateCompleteEvent struct {
	BaseUserEvent
	Original User `json:"original,omitempty"`
}

*

  • Models the User Update Event once it is completed. This cannot be transactional. *
  • @author Daniel DeGroff

type UserUpdateEvent 

type UserUpdateEvent struct {
	BaseUserEvent
	Original User `json:"original,omitempty"`
}

*

  • Models the User Update Event. *
  • @author Brian Pontarelli

type UserVerificationRequirement 

type UserVerificationRequirement string

* 

const (
	UserVerificationRequirement_Required    UserVerificationRequirement = "required"
	UserVerificationRequirement_Preferred   UserVerificationRequirement = "preferred"
	UserVerificationRequirement_Discouraged UserVerificationRequirement = "discouraged"
)

func (UserVerificationRequirement) String 

func (e UserVerificationRequirement) String() string

type UsernameModeration 

type UsernameModeration struct {
	Enableable
	ApplicationId string `json:"applicationId,omitempty"`
}

type ValidateResponse 

type ValidateResponse struct {
	BaseHTTPResponse
	Jwt JWT `json:"jwt,omitempty"`
}

*

  • @author Daniel DeGroff

func (*ValidateResponse) SetStatus 

func (b *ValidateResponse) SetStatus(status int)

type VerificationStrategy 

type VerificationStrategy string

*

  • @author Daniel DeGroff
const (
	VerificationStrategy_ClickableLink VerificationStrategy = "ClickableLink"
	VerificationStrategy_FormField     VerificationStrategy = "FormField"
)

func (VerificationStrategy) String 

func (e VerificationStrategy) String() string

type VerifyEmailRequest 

type VerifyEmailRequest struct {
	BaseEventRequest
	OneTimeCode    string `json:"oneTimeCode,omitempty"`
	UserId         string `json:"userId,omitempty"`
	VerificationId string `json:"verificationId,omitempty"`
}

*

  • @author Daniel DeGroff

type VerifyEmailResponse 

type VerifyEmailResponse struct {
	BaseHTTPResponse
	OneTimeCode    string `json:"oneTimeCode,omitempty"`
	VerificationId string `json:"verificationId,omitempty"`
}

*

  • @author Daniel DeGroff

func (*VerifyEmailResponse) SetStatus 

func (b *VerifyEmailResponse) SetStatus(status int)

type VerifyRegistrationRequest 

type VerifyRegistrationRequest struct {
	BaseEventRequest
	OneTimeCode    string `json:"oneTimeCode,omitempty"`
	VerificationId string `json:"verificationId,omitempty"`
}

*

  • @author Daniel DeGroff

type VerifyRegistrationResponse 

type VerifyRegistrationResponse struct {
	BaseHTTPResponse
	OneTimeCode    string `json:"oneTimeCode,omitempty"`
	VerificationId string `json:"verificationId,omitempty"`
}

*

  • @author Daniel DeGroff

func (*VerifyRegistrationResponse) SetStatus 

func (b *VerifyRegistrationResponse) SetStatus(status int)

type VersionResponse 

type VersionResponse struct {
	BaseHTTPResponse
	Version string `json:"version,omitempty"`
}

*

  • @author Daniel DeGroff

func (*VersionResponse) SetStatus 

func (b *VersionResponse) SetStatus(status int)

type WebAuthnAssertResponse 

type WebAuthnAssertResponse struct {
	BaseHTTPResponse
	Credential WebAuthnCredential `json:"credential,omitempty"`
}

*

  • API response for completing WebAuthn assertion *
  • @author Spencer Witt

func (*WebAuthnAssertResponse) SetStatus 

func (b *WebAuthnAssertResponse) SetStatus(status int)

type WebAuthnAuthenticatorAuthenticationResponse 

type WebAuthnAuthenticatorAuthenticationResponse struct {
	BaseHTTPResponse
	AuthenticatorData string `json:"authenticatorData,omitempty"`
	ClientDataJSON    string `json:"clientDataJSON,omitempty"`
	Signature         string `json:"signature,omitempty"`
	UserHandle        string `json:"userHandle,omitempty"`
}

*

  • The <i>authenticator's</i> response for the authentication ceremony in its encoded format *
  • @author Spencer Witt

func (*WebAuthnAuthenticatorAuthenticationResponse) SetStatus 

func (b *WebAuthnAuthenticatorAuthenticationResponse) SetStatus(status int)

type WebAuthnAuthenticatorRegistrationResponse 

type WebAuthnAuthenticatorRegistrationResponse struct {
	BaseHTTPResponse
	AttestationObject string `json:"attestationObject,omitempty"`
	ClientDataJSON    string `json:"clientDataJSON,omitempty"`
}

*

  • The <i>authenticator's</i> response for the registration ceremony in its encoded format *
  • @author Spencer Witt

func (*WebAuthnAuthenticatorRegistrationResponse) SetStatus 

func (b *WebAuthnAuthenticatorRegistrationResponse) SetStatus(status int)

type WebAuthnCredential 

type WebAuthnCredential struct {
	Algorithm                             CoseAlgorithmIdentifier `json:"algorithm,omitempty"`
	AttestationType                       AttestationType         `json:"attestationType,omitempty"`
	AuthenticatorSupportsUserVerification bool                    `json:"authenticatorSupportsUserVerification"`
	CredentialId                          string                  `json:"credentialId,omitempty"`
	Data                                  map[string]interface{}  `json:"data,omitempty"`
	Discoverable                          bool                    `json:"discoverable"`
	DisplayName                           string                  `json:"displayName,omitempty"`
	Id                                    string                  `json:"id,omitempty"`
	InsertInstant                         int64                   `json:"insertInstant,omitempty"`
	LastUseInstant                        int64                   `json:"lastUseInstant,omitempty"`
	Name                                  string                  `json:"name,omitempty"`
	PublicKey                             string                  `json:"publicKey,omitempty"`
	RelyingPartyId                        string                  `json:"relyingPartyId,omitempty"`
	SignCount                             int                     `json:"signCount,omitempty"`
	TenantId                              string                  `json:"tenantId,omitempty"`
	Transports                            []string                `json:"transports,omitempty"`
	UserAgent                             string                  `json:"userAgent,omitempty"`
	UserId                                string                  `json:"userId,omitempty"`
}

*

  • A User's WebAuthnCredential. Contains all data required to complete WebAuthn authentication ceremonies. *
  • @author Spencer Witt

type WebAuthnCredentialImportRequest 

type WebAuthnCredentialImportRequest struct {
	Credentials           []WebAuthnCredential `json:"credentials,omitempty"`
	ValidateDbConstraints bool                 `json:"validateDbConstraints"`
}

*

  • API request to import an existing WebAuthn credential(s) *
  • @author Spencer Witt

type WebAuthnCredentialResponse 

type WebAuthnCredentialResponse struct {
	BaseHTTPResponse
	Credential  WebAuthnCredential   `json:"credential,omitempty"`
	Credentials []WebAuthnCredential `json:"credentials,omitempty"`
}

*

  • WebAuthn Credential API response *
  • @author Spencer Witt

func (*WebAuthnCredentialResponse) SetStatus 

func (b *WebAuthnCredentialResponse) SetStatus(status int)

type WebAuthnExtensionsClientOutputs 

type WebAuthnExtensionsClientOutputs struct {
	CredProps CredentialPropertiesOutput `json:"credProps,omitempty"`
}

*

  • Contains extension output for requested extensions during a WebAuthn ceremony *
  • @author Spencer Witt

type WebAuthnLoginRequest 

type WebAuthnLoginRequest struct {
	BaseLoginRequest
	Credential       WebAuthnPublicKeyAuthenticationRequest `json:"credential,omitempty"`
	Origin           string                                 `json:"origin,omitempty"`
	RpId             string                                 `json:"rpId,omitempty"`
	TwoFactorTrustId string                                 `json:"twoFactorTrustId,omitempty"`
}

*

  • Request to complete the WebAuthn registration ceremony *
  • @author Spencer Witt

type WebAuthnPublicKeyAuthenticationRequest 

type WebAuthnPublicKeyAuthenticationRequest struct {
	ClientExtensionResults WebAuthnExtensionsClientOutputs             `json:"clientExtensionResults,omitempty"`
	Id                     string                                      `json:"id,omitempty"`
	Response               WebAuthnAuthenticatorAuthenticationResponse `json:"response,omitempty"`
	RpId                   string                                      `json:"rpId,omitempty"`
	Type                   string                                      `json:"type,omitempty"`
}

*

  • Request to authenticate with WebAuthn *
  • @author Spencer Witt

type WebAuthnPublicKeyRegistrationRequest 

type WebAuthnPublicKeyRegistrationRequest struct {
	ClientExtensionResults WebAuthnExtensionsClientOutputs           `json:"clientExtensionResults,omitempty"`
	Id                     string                                    `json:"id,omitempty"`
	Response               WebAuthnAuthenticatorRegistrationResponse `json:"response,omitempty"`
	RpId                   string                                    `json:"rpId,omitempty"`
	Transports             []string                                  `json:"transports,omitempty"`
	Type                   string                                    `json:"type,omitempty"`
}

*

  • Request to register a new public key with WebAuthn *
  • @author Spencer Witt

type WebAuthnRegisterCompleteRequest 

type WebAuthnRegisterCompleteRequest struct {
	Credential WebAuthnPublicKeyRegistrationRequest `json:"credential,omitempty"`
	Origin     string                               `json:"origin,omitempty"`
	RpId       string                               `json:"rpId,omitempty"`
	UserId     string                               `json:"userId,omitempty"`
}

*

  • Request to complete the WebAuthn registration ceremony for a new credential,. *
  • @author Spencer Witt

type WebAuthnRegisterCompleteResponse 

type WebAuthnRegisterCompleteResponse struct {
	BaseHTTPResponse
	Credential WebAuthnCredential `json:"credential,omitempty"`
}

*

  • API response for completing WebAuthn credential registration or assertion *
  • @author Spencer Witt

func (*WebAuthnRegisterCompleteResponse) SetStatus 

func (b *WebAuthnRegisterCompleteResponse) SetStatus(status int)

type WebAuthnRegisterStartRequest 

type WebAuthnRegisterStartRequest struct {
	DisplayName string           `json:"displayName,omitempty"`
	Name        string           `json:"name,omitempty"`
	UserAgent   string           `json:"userAgent,omitempty"`
	UserId      string           `json:"userId,omitempty"`
	Workflow    WebAuthnWorkflow `json:"workflow,omitempty"`
}

*

  • API request to start a WebAuthn registration ceremony *
  • @author Spencer Witt

type WebAuthnRegisterStartResponse 

type WebAuthnRegisterStartResponse struct {
	BaseHTTPResponse
	Options PublicKeyCredentialCreationOptions `json:"options,omitempty"`
}

*

  • API response for starting a WebAuthn registration ceremony *
  • @author Spencer Witt

func (*WebAuthnRegisterStartResponse) SetStatus 

func (b *WebAuthnRegisterStartResponse) SetStatus(status int)

type WebAuthnRegistrationExtensionOptions 

type WebAuthnRegistrationExtensionOptions struct {
	CredProps bool `json:"credProps"`
}

*

  • Options to request extensions during credential registration *
  • @author Spencer Witt

type WebAuthnStartRequest 

type WebAuthnStartRequest struct {
	ApplicationId string                 `json:"applicationId,omitempty"`
	CredentialId  string                 `json:"credentialId,omitempty"`
	LoginId       string                 `json:"loginId,omitempty"`
	State         map[string]interface{} `json:"state,omitempty"`
	UserId        string                 `json:"userId,omitempty"`
	Workflow      WebAuthnWorkflow       `json:"workflow,omitempty"`
}

*

  • API request to start a WebAuthn authentication ceremony *
  • @author Spencer Witt

type WebAuthnStartResponse 

type WebAuthnStartResponse struct {
	BaseHTTPResponse
	Options PublicKeyCredentialRequestOptions `json:"options,omitempty"`
}

*

  • API response for starting a WebAuthn authentication ceremony *
  • @author Spencer Witt

func (*WebAuthnStartResponse) SetStatus 

func (b *WebAuthnStartResponse) SetStatus(status int)

type WebAuthnWorkflow 

type WebAuthnWorkflow string

*

  • Identifies the WebAuthn workflow. This will affect the parameters used for credential creation
  • and request based on the Tenant configuration. *
  • @author Spencer Witt
const (
	WebAuthnWorkflow_Bootstrap        WebAuthnWorkflow = "bootstrap"
	WebAuthnWorkflow_General          WebAuthnWorkflow = "general"
	WebAuthnWorkflow_Reauthentication WebAuthnWorkflow = "reauthentication"
)

func (WebAuthnWorkflow) String 

func (e WebAuthnWorkflow) String() string

type Webhook 

type Webhook struct {
	ConnectTimeout             int                           `json:"connectTimeout,omitempty"`
	Data                       map[string]interface{}        `json:"data,omitempty"`
	Description                string                        `json:"description,omitempty"`
	EventsEnabled              map[EventType]bool            `json:"eventsEnabled,omitempty"`
	Global                     bool                          `json:"global"`
	Headers                    map[string]string             `json:"headers,omitempty"`
	HttpAuthenticationPassword string                        `json:"httpAuthenticationPassword,omitempty"`
	HttpAuthenticationUsername string                        `json:"httpAuthenticationUsername,omitempty"`
	Id                         string                        `json:"id,omitempty"`
	InsertInstant              int64                         `json:"insertInstant,omitempty"`
	LastUpdateInstant          int64                         `json:"lastUpdateInstant,omitempty"`
	ReadTimeout                int                           `json:"readTimeout,omitempty"`
	SignatureConfiguration     WebhookSignatureConfiguration `json:"signatureConfiguration,omitempty"`
	SslCertificate             string                        `json:"sslCertificate,omitempty"`
	SslCertificateKeyId        string                        `json:"sslCertificateKeyId,omitempty"`
	TenantIds                  []string                      `json:"tenantIds,omitempty"`
	Url                        string                        `json:"url,omitempty"`
}

*

  • A server where events are sent. This includes user action events and any other events sent by FusionAuth. *
  • @author Brian Pontarelli

type WebhookAttemptLog 

type WebhookAttemptLog struct {
	AttemptResult       WebhookAttemptResult   `json:"attemptResult,omitempty"`
	Data                map[string]interface{} `json:"data,omitempty"`
	EndInstant          int64                  `json:"endInstant,omitempty"`
	Id                  string                 `json:"id,omitempty"`
	StartInstant        int64                  `json:"startInstant,omitempty"`
	WebhookCallResponse WebhookCallResponse    `json:"webhookCallResponse,omitempty"`
	WebhookEventLogId   string                 `json:"webhookEventLogId,omitempty"`
	WebhookId           string                 `json:"webhookId,omitempty"`
}

*

  • A webhook call attempt log. *
  • @author Spencer Witt

type WebhookAttemptLogResponse 

type WebhookAttemptLogResponse struct {
	BaseHTTPResponse
	WebhookAttemptLog WebhookAttemptLog `json:"webhookAttemptLog,omitempty"`
}

*

  • Webhook attempt log response. *
  • @author Spencer Witt

func (*WebhookAttemptLogResponse) SetStatus 

func (b *WebhookAttemptLogResponse) SetStatus(status int)

type WebhookAttemptResult 

type WebhookAttemptResult string

*

  • The possible states of an individual webhook attempt to a single endpoint. *
  • @author Spencer Witt
const (
	WebhookAttemptResult_Success WebhookAttemptResult = "Success"
	WebhookAttemptResult_Failure WebhookAttemptResult = "Failure"
	WebhookAttemptResult_Unknown WebhookAttemptResult = "Unknown"
)

func (WebhookAttemptResult) String 

func (e WebhookAttemptResult) String() string

type WebhookCallResponse 

type WebhookCallResponse struct {
	BaseHTTPResponse
	Exception  string `json:"exception,omitempty"`
	StatusCode int    `json:"statusCode,omitempty"`
	Url        string `json:"url,omitempty"`
}

*

  • A webhook call response. *
  • @author Spencer Witt

func (*WebhookCallResponse) SetStatus 

func (b *WebhookCallResponse) SetStatus(status int)

type WebhookEventLog 

type WebhookEventLog struct {
	Attempts           []WebhookAttemptLog    `json:"attempts,omitempty"`
	Data               map[string]interface{} `json:"data,omitempty"`
	Event              EventRequest           `json:"event,omitempty"`
	EventResult        WebhookEventResult     `json:"eventResult,omitempty"`
	EventType          EventType              `json:"eventType,omitempty"`
	FailedAttempts     int                    `json:"failedAttempts,omitempty"`
	Id                 string                 `json:"id,omitempty"`
	InsertInstant      int64                  `json:"insertInstant,omitempty"`
	LastAttemptInstant int64                  `json:"lastAttemptInstant,omitempty"`
	LastUpdateInstant  int64                  `json:"lastUpdateInstant,omitempty"`
	LinkedObjectId     string                 `json:"linkedObjectId,omitempty"`
	Sequence           int64                  `json:"sequence,omitempty"`
	SuccessfulAttempts int                    `json:"successfulAttempts,omitempty"`
}

type WebhookEventLogConfiguration 

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

*

  • The system configuration for Webhook Event Log data. *
  • @author Spencer Witt

type WebhookEventLogResponse 

type WebhookEventLogResponse struct {
	BaseHTTPResponse
	WebhookEventLog WebhookEventLog `json:"webhookEventLog,omitempty"`
}

*

  • Webhook event log response. *
  • @author Spencer Witt

func (*WebhookEventLogResponse) SetStatus 

func (b *WebhookEventLogResponse) SetStatus(status int)

type WebhookEventLogSearchCriteria 

type WebhookEventLogSearchCriteria struct {
	BaseSearchCriteria
	End         int64              `json:"end,omitempty"`
	Event       string             `json:"event,omitempty"`
	EventResult WebhookEventResult `json:"eventResult,omitempty"`
	EventType   EventType          `json:"eventType,omitempty"`
	Start       int64              `json:"start,omitempty"`
}

*

  • Search criteria for the webhook event log. *
  • @author Spencer Witt

type WebhookEventLogSearchRequest 

type WebhookEventLogSearchRequest struct {
	Search WebhookEventLogSearchCriteria `json:"search,omitempty"`
}

*

  • Webhook event log search request. *
  • @author Spencer Witt

type WebhookEventLogSearchResponse 

type WebhookEventLogSearchResponse struct {
	BaseHTTPResponse
	Total            int64             `json:"total,omitempty"`
	WebhookEventLogs []WebhookEventLog `json:"webhookEventLogs,omitempty"`
}

*

  • Webhook event log search response. *
  • @author Spencer Witt

func (*WebhookEventLogSearchResponse) SetStatus 

func (b *WebhookEventLogSearchResponse) SetStatus(status int)

type WebhookEventResult 

type WebhookEventResult string

*

  • The possible result states of a webhook event. This tracks the success of the overall webhook transaction according to the {@link TransactionType}
  • and configured webhooks. *
  • @author Spencer Witt
const (
	WebhookEventResult_Failed    WebhookEventResult = "Failed"
	WebhookEventResult_Running   WebhookEventResult = "Running"
	WebhookEventResult_Succeeded WebhookEventResult = "Succeeded"
)

func (WebhookEventResult) String 

func (e WebhookEventResult) String() string

type WebhookRequest 

type WebhookRequest struct {
	Webhook Webhook `json:"webhook,omitempty"`
}

*

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

type WebhookResponse 

type WebhookResponse struct {
	BaseHTTPResponse
	Webhook  Webhook   `json:"webhook,omitempty"`
	Webhooks []Webhook `json:"webhooks,omitempty"`
}

*

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

func (*WebhookResponse) SetStatus 

func (b *WebhookResponse) SetStatus(status int)

type WebhookSearchCriteria 

type WebhookSearchCriteria struct {
	BaseSearchCriteria
	Description string `json:"description,omitempty"`
	TenantId    string `json:"tenantId,omitempty"`
	Url         string `json:"url,omitempty"`
}

*

  • Search criteria for webhooks. *
  • @author Spencer Witt

type WebhookSearchRequest 

type WebhookSearchRequest struct {
	Search WebhookSearchCriteria `json:"search,omitempty"`
}

*

  • Search request for webhooks *
  • @author Spencer Witt

type WebhookSearchResponse 

type WebhookSearchResponse struct {
	BaseHTTPResponse
	Total    int64     `json:"total,omitempty"`
	Webhooks []Webhook `json:"webhooks,omitempty"`
}

*

  • Webhook search response *
  • @author Spencer Witt

func (*WebhookSearchResponse) SetStatus 

func (b *WebhookSearchResponse) SetStatus(status int)

type WebhookSignatureConfiguration 

type WebhookSignatureConfiguration struct {
	Enableable
	SigningKeyId string `json:"signingKeyId,omitempty"`
}

*

  • Configuration for signing webhooks. *
  • @author Brent Halsey

type XMLSignatureLocation 

type XMLSignatureLocation string
const (
	XMLSignatureLocation_Assertion XMLSignatureLocation = "Assertion"
	XMLSignatureLocation_Response  XMLSignatureLocation = "Response"
)

func (XMLSignatureLocation) String 

func (e XMLSignatureLocation) String() string

type XboxApplicationConfiguration 

type XboxApplicationConfiguration 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 XboxIdentityProvider 

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

*

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.