package
1.9.0
Repository: https://github.com/auth0/go-auth0.git
Documentation: pkg.go.dev

# Functions

Body configures a requests body.
ExcludeFields configures a request to exclude the desired fields.
From configures a request to start from the specified checkpoint.
Header configures a request to add HTTP headers to requests made to Auth0.
IncludeFields configures a request to include the desired fields.
IncludeTotals configures a request to include totals.
New creates a new Auth0 Management client by authenticating using the supplied client id and secret.
Page configures a request to receive a specific page, if the results where concatenated.
Parameter configures a request to add arbitrary query parameters to requests made to Auth0.
PerPage configures a request to limit the amount of items in the result.
Query configures a request to search on specific query parameters.
Sort configures a request to sort data by the selected field.
Stringify returns a string representation of the value passed as an argument.
Take configures a request to limit the amount of items in the result for a checkpoint based request.
WithAuth0ClientEnvEntry allows adding extra environment keys to the client information.
WithClient configures management to use the provided client.
WithClientCredentials configures management to authenticate using the client credentials authentication flow.
WithClientCredentialsAndAudience configures management to authenticate using the client credentials authentication flow and a custom audience.
WithDebug configures the management client to dump http requests and responses to stdout.
WithInsecure configures management to not use an authentication token and use HTTP instead of HTTPS.
WithNoAuth0ClientInfo configures the management client to not send the "Auth0-Client" header at all.
WithNoRetries configures the management client to only retry under the conditions provided.
WithRetries configures the management client to only retry under the conditions provided.
WithStaticToken configures management to authenticate using a static authentication token.
WithUserAgent configures the management client to use the provided user agent string instead of the default one.

# Constants

ActionBindingReferenceByID constant.
ActionBindingReferenceByName constant.
ActionStatusBuilding constant.
ActionStatusBuilt constant.
ActionStatusFailed constant.
ActionStatusPackaged constant.
ActionStatusPending constant.
ActionStatusRetrying constant.
ActionTriggerClientCredentials constant.
ActionTriggerPostLogin constant.
ConnectionStrategyAD constant.
ConnectionStrategyADFS constant.
ConnectionStrategyAmazon constant.
ConnectionStrategyApple constant.
ConnectionStrategyAuth0 constant.
ConnectionStrategyAzureAD constant.
ConnectionStrategyBitBucket constant.
ConnectionStrategyBox constant.
ConnectionStrategyCustom constant.
ConnectionStrategyDropbox constant.
ConnectionStrategyEmail constant.
ConnectionStrategyFacebook constant.
ConnectionStrategyGitHub constant.
ConnectionStrategyGoogleApps constant.
ConnectionStrategyGoogleOAuth2 constant.
ConnectionStrategyLine constant.
ConnectionStrategyLinkedin constant.
ConnectionStrategyOAuth2 constant.
ConnectionStrategyOIDC constant.
ConnectionStrategyOkta constant.
ConnectionStrategyPaypal constant.
ConnectionStrategyPingFederate constant.
ConnectionStrategySalesforce constant.
ConnectionStrategySalesforceCommunity constant.
ConnectionStrategySalesforceSandbox constant.
ConnectionStrategySAML constant.
ConnectionStrategyShopify constant.
ConnectionStrategySMS constant.
ConnectionStrategyTwitter constant.
ConnectionStrategyWindowsLive constant.
ConnectionStrategyWordpress constant.
ConnectionStrategyYahoo constant.
EmailProviderAzureCS constant.
EmailProviderMailgun constant.
EmailProviderMandrill constant.
EmailProviderMS365 constant.
EmailProviderSendGrid constant.
EmailProviderSES constant.
EmailProviderSMTP constant.
EmailProviderSparkPost constant.
LogStreamTypeAmazonEventBridge constant.
LogStreamTypeAzureEventGrid constant.
LogStreamTypeDatadog constant.
LogStreamTypeHTTP constant.
LogStreamTypeMixpanel constant.
LogStreamTypeSegment constant.
LogStreamTypeSplunk constant.
LogStreamTypeSumo constant.
PromptLogin represents the login prompt.
PromptLoginID represents the login-id prompt.
PromptLoginPassword represents the login-password prompt.
PromptSignup represents the signup prompt.
PromptSignupID represents the signup-id prompt.
PromptSignupPassword represents the signup-password prompt.

# Structs

Action represents an Auth0 Action.
ActionBinding is used to attach an Action to an ActionTrigger.
ActionBindingList is a list of ActionBindings.
ActionBindingReference holds the reference of an Action attached to an ActionTrigger.
ActionDependency is used to allow the use of packages from the npm registry.
ActionExecution is used to retrieve information about a specific execution of an ActionTrigger.
ActionExecutionResult holds the results of an ActionExecution.
ActionList is a list of Actions.
ActionSecret is used to hold Secret values within an Action.
ActionTrigger is part of a Flow.
ActionTriggerList is a list of ActionTriggers.
ActionVersion is used to manage Actions version history.
ActionVersionError is used to keep track of the errors of a specific ActionVersion.
ActionVersionList is a list of ActionVersions.
AuthenticationMethod belonging to a user.
AuthenticationMethodList is an envelope struct which is used when calling GetAuthenticationMethods().
AuthenticationMethodReference used within the AuthenticationMethod.
AuthenticationMethods represents the options for enabling authentication methods for the connection.
AWSClientAddon defines the `aws` settings for a client.
AzureBlobClientAddon defines the `azure_blob` settings for a client.
AzureSBClientAddon defines the `azure_sb` settings for a client.
BackChannelLogoutInitiators defines the setting for OIDC logout initiators for a Client.
BlacklistToken is a token that has been blacklisted.
BoxClientAddon defines the `box` settings for a client.
Branding is used to customize the look and feel of Auth0 to align with an organization's brand requirements and user expectations.
BrandingColors are used to customize the Universal Login Page.
BrandingFont is used to customize the font on the Universal Login Page.
BrandingPageBackgroundGradient is used to customize the background color of the Universal Login Page.
BrandingTheme is used to customize the login experience by selecting colors, fonts, and more.
BrandingThemeBorders contains borders settings for the BrandingTheme.
BrandingThemeColors contains colors settings for the BrandingTheme.
BrandingThemeFonts contains fonts settings for the BrandingTheme.
BrandingThemePageBackground contains page background settings for the BrandingTheme.
BrandingThemeText contains text settings for the BrandingThemeFonts.
BrandingThemeWidget contains widget settings for the BrandingTheme.
BrandingUniversalLogin is used to customize the body of the Universal Login Page.
BreachedPasswordDetection protects applications from bad actors logging in with stolen credentials.
BreachedPasswordDetectionPreUserRegistration is used to specify breached password detection configuration (shields) for the sign up flow.
BreachedPasswordDetectionStage is used to specify per-stage configuration options.
BruteForceProtection safeguards against a single IP address attacking a single user account.
Client is an application or a sso integration.
ClientAddons defines the `addons` settings for a Client.
ClientAuthenticationMethods defines client authentication method settings for the client.
ClientGrant is a method through which applications can gain Access Tokens.
ClientGrantList is a list of ClientGrants.
ClientJWTConfiguration is used to configure JWT settings for our Client.
ClientList is a list of Clients.
ClientMobile is used to configure mobile app settings.
ClientMobileAndroid is used to configure Android app settings.
ClientMobileIOS is used to configure iOS app settings.
ClientNativeSocialLogin is used to configure Native Social Login for our Client.
ClientNativeSocialLoginSupportEnabled used to indicate if support is enabled or not.
ClientRefreshToken is used to configure the Refresh Token settings for our Client.
ClientSignedRequestObject is used to configure JWT-secured Authorization Requests (JAR) settings for our Client.
CloudBeesClientAddon defines the `cloudbees` settings for a client.
ConcurClientAddon defines the `concur` settings for a client.
Connection is the relationship between Auth0 and a source of users.
ConnectionGatewayAuthentication is used to configure the GatewayAuthentication settings on a ConnectionOptionsSMS.
ConnectionList is a list of Connections.
ConnectionOptions is used to configure Connections.
ConnectionOptionsAD is used to configure an AD Connection.
ConnectionOptionsADFS is used to configure an ADFS Connection.
ConnectionOptionsApple is used to configure an Apple Connection.
ConnectionOptionsAttributeAllowedTypes defines allowed types for an attribute.
ConnectionOptionsAttributeIdentifier defines whether an attribute is active as an identifier.
ConnectionOptionsAttributes defines the structure for attribute configurations.
ConnectionOptionsAttributeSignup defines signup settings for an attribute.
ConnectionOptionsAttributeValidation defines validation settings for an attribute.
ConnectionOptionsAttributeVerification defines verification settings for an attribute.
ConnectionOptionsAzureAD is used to configure an AzureAD Connection.
ConnectionOptionsEmail is used to configure an Email Connection.
ConnectionOptionsEmailAttribute defines configuration settings for email attributes.
ConnectionOptionsEmailSettings is used to configure the email settings on a ConnectionOptionsEmail.
ConnectionOptionsFacebook is used to configure a Facebook Connection.
ConnectionOptionsGitHub is used to configure a GitHub Connection.
ConnectionOptionsGoogleApps is used to configure a GoogleApps Connection.
ConnectionOptionsGoogleOAuth2 is used to configure a GoogleOAuth2 Connection.
ConnectionOptionsLinkedin is used to configure a Linkedin Connection.
ConnectionOptionsOAuth2 is used to configure an OAuth2 Connection.
ConnectionOptionsOIDC is used to configure an OIDC Connection.
ConnectionOptionsOIDCAttributeMap contains the mapping of claims received from the identity provider (IdP).
ConnectionOptionsOIDCConnectionSettings contains PKCE configuration for the connection.
ConnectionOptionsOkta is used to configure an Okta Workforce Connection.
ConnectionOptionsOTP is used to configure the OTP settings on a ConnectionOptionsEmail.
ConnectionOptionsPhoneNumberAttribute defines configuration settings for phone number attributes.
ConnectionOptionsPingFederate is used to configure a Ping Federate Connection.
ConnectionOptionsSalesforce is used to configure a SalesForce Connection.
ConnectionOptionsSAML is used to configure a SAML Connection.
ConnectionOptionsSAMLDecryptionKey is used to configure the DecryptionKey settings on a ConnectionOptionsSAML.
ConnectionOptionsSAMLIdpInitiated is used to configure the IdpInitiated settings on a ConnectionOptionsSAML.
ConnectionOptionsSAMLSigningKey is used to configure the SigningKey settings on a ConnectionOptionsSAML.
ConnectionOptionsSMS is used to configure an SMS Connection.
ConnectionOptionsUsernameAttribute defines configuration settings for username attributes.
ConnectionOptionsWindowsLive is used to configure a WindowsLive Connection.
CreateEnrollmentTicket used to create an enrollment ticket.
Credential is used to configure Client Credentials.
CustomDomain to be used on authentication pages.
CustomDomainVerification is used to verify a CustomDomain.
DailyStat for an Auth0 Tenant.
DropboxClientAddon defines the `dropbox` settings for a client.
EchoSignClientAddon defines the `echosign` settings for a client.
EgnyteClientAddon defines the `egnyte` settings for a client.
EmailProvider is used to configure Email Providers.
EmailProviderCredentialsAzureCS represent the credentials required to use the azure_cs provider.
EmailProviderCredentialsMailgun represent the credentials required to use the mailgun provider.
EmailProviderCredentialsMandrill represent the credentials required to use the mandrill provider.
EmailProviderCredentialsMS365 represent the credentials required to use the ms365 provider.
EmailProviderCredentialsSendGrid represent the credentials required to use the sendgrid provider.
EmailProviderCredentialsSES represent the credentials required to use the ses provider.
EmailProviderCredentialsSMTP represent the credentials required to use the smtp provider.
EmailProviderCredentialsSparkPost represent the credentials required to use the sparkpost provider.
EmailProviderSettingsMandrill are the provider specific settings used by the mandrill provider.
EmailProviderSettingsMandrillMessage contains the message settings content for the mandrill provider.
EmailProviderSettingsSES are the provider specific settings used by the ses provider.
EmailProviderSettingsSESMessage contains the message settings content for the ses provider.
EmailProviderSettingsSMTP are the provider specific settings used by the smtp provider.
EmailProviderSettingsSMTPHeaders contains the headers settings content for the smtp provider.
EmailTemplate is used to customize emails.
Enrollment is used for MultiFactor Authentication.
EnrollmentTicket holds information on the ticket ID and URL.
FirebaseClientAddon defines the `firebase` settings for a client.
Grant is a way of retrieving an Access Token.
GrantList is a list of Grants.
GuardianManager manages Auth0 Guardian resources.
Hook is a secure, self-contained function that allows the behavior of Auth0 to be customized.
HookList is a list of Hooks.
Job is used for importing/exporting users or for sending email address verification emails.
JobError is used to check for errors during jobs.
JobSummary includes totals of successful, failed, inserted, and updated records.
JobUserErrors holds errors for the specific user during a job.
LayerClientAddon defines the `layer` settings for a client.
List is an envelope which is typically used when calling List() or Search() methods.
Log for analyzing business needs.
LogStream is used to export tenant log events to a log event analysis service.
LogStreamSinkAmazonEventBridge is used to export logs to Amazon EventBridge.
LogStreamSinkAzureEventGrid is used to export logs to Azure Event Grid.
LogStreamSinkDatadog is used to export logs to Datadog.
LogStreamSinkHTTP is used to export logs to Custom Webhooks.
LogStreamSinkMixpanel is used to export logs to Mixpanel.
LogStreamSinkSegment is used to export logs to Segment.
LogStreamSinkSplunk is used to export logs to Splunk.
LogStreamSinkSumo is used to export logs to Sumo Logic.
Management is an Auth0 management client used to interact with the Auth0 Management API v2.
MSCRMClientAddon defines the `mscrm` settings for a client.
MultiFactor Authentication method.
MultiFactorDUOSettings holds settings for configuring DUO.
MultiFactorManager manages MultiFactor Authentication options.
MultiFactorProvider holds provider type for MultiFactor Authentication.
MultiFactorProviderAmazonSNS is an AmazonSNS provider used for MultiFactorPush Authentication.
MultiFactorProviderTwilio is used for Twilio MultiFactor Authentication.
MultiFactorPushCustomApp holds custom multi-factor authentication app settings.
MultiFactorPushDirectAPNS holds the Apple APNS provider configuration.
MultiFactorPushDirectFCM holds the Google FCM provider configuration.
MultiFactorSMSTemplate holds the sms template for MultiFactor Authentication.
MultiFactorWebAuthnSettings holds settings for configuring WebAuthn Roaming or Platform.
NewRelicClientAddon defines the `newrelic` settings for a client.
Office365ClientAddon defines the `office365` settings for a client.
OIDCBackchannelLogout defines the `oidc_backchannel_logout` settings for the client.
OIDCLogout defines the `oidc_logout` settings for the client.
Organization is used to allow B2B customers to better manage their partners and customers, and to customize the ways that end-users access their applications.
OrganizationBranding holds branding information for an Organization.
OrganizationConnection holds connection information for an Organization.
OrganizationConnectionDetails holds connection details for an Organization.
OrganizationConnectionList is a list of OrganizationConnection.
OrganizationInvitation holds information on the invitation to an Organization.
OrganizationInvitationInvitee holds the name of the invitee.
OrganizationInvitationInviter holds the name of the inviter.
OrganizationInvitationList is a list of OrganizationInvitations.
OrganizationList is a list of Organizations.
OrganizationMember holds member information for an Organization.
OrganizationMemberList is a list of OrganizationMembers.
OrganizationMemberListRole holds member role information.
OrganizationMemberRole holds member role information.
OrganizationMemberRoleList is a list of OrganizationMemberRoles.
PasskeyAuthenticationMethod represents passkey authentication enablement for the connection.
PasskeyOptions contains Passkey configuration for the connection.
PasswordAuthenticationMethod represents password authentication enablement for the connection.
Permission is granted to a Role.
PermissionList holds a list of Permissions.
PhoneMessageTypes holds message types for phone MultiFactor Authentication.
PreLogin is used to customize thresholds for login flow.
PreUserRegistration is used to customize thresholds for sign up flow.
PrivateKeyJWT defines the `private_key_jwt` client authentication method settings for the client.
Prompt is used within the Login Page.
PromptPartials to be used for Custom Prompt Partials.
RefreshToken represents a refresh token for a user.
RefreshTokenList represents a list of user refresh tokens.
RefreshTokenResourceServer represents the resource server associated with a refresh token.
ResourceServer is an entity that represents an external resource, capable of accepting and responding to protected resource requests made by applications.
ResourceServerAuthorizationDetails specifies the authorization details for the resource server.
ResourceServerList is a list of ResourceServers.
ResourceServerProofOfPossession specifies the proof-of-possession configuration for access tokens.
ResourceServerScope defines the specific actions, resource servers can be allowed to do.
ResourceServerTokenEncryption specifies the token encryption for the resource server.
ResourceServerTokenEncryptionKey specifies the encryption key for the token encryption.
RMSClientAddon defines the `rms` settings for a client.
Role is used to assign roles to a User.
RoleList holds a list of Roles.
Rule is used as part of the authentication pipeline.
RuleConfig are key value pairs used to configure Rules.
RuleList holds a list of Rules.
SalesforceAPIClientAddon defines the `salesforce_api` settings for a client.
SalesforceClientAddon defines the `salesforce` settings for a client.
SalesforceSandboxAPIClientAddon defines the `salesforce_sandbox_api` settings for a client.
SAML2ClientAddon defines the `SAML2` settings for a Client.
SAML2ClientAddonLogout defines the `logout` settings for the SAML2Addon.
SAPAPIClientAddon defines the `sap` settings for a client.
SCIMConfiguration represents the SCIM configuration for a connection.
SCIMConfigurationMapping represents the mapping between Auth0 and SCIM fields.
SCIMToken represents the SCIM token used by the client.
SelfServiceProfile allows to configure SSO so that customers can independently set up SSO and sign in to your application.
SelfServiceProfileTicket is used to created self-service ticket for a set of clients and organizations.
SelfServiceProfileTicketConnectionConfig sets the configuration for SSOTicket.
SelfServiceProfileTicketEnabledOrganizations is the list of Organizations associated with the SSO Ticket.
SelfServiceProfileUserAttributes is used to determine optional attributes.
SelfSignedTLSClientAuth defines the `self_signed_tls_client_auth` client authentication method settings for the client.
SentryClientAddon defines the `sentry` settings for a client.
SharePointClientAddon defines the `sharepoint` settings for a client.
SigningKey is used for signing tokens.
SlackClientAddon defines the `slack` settings for a client.
SpringCMClientAddon defines the `springcm` settings for a client.
SSOIntegrationClientAddon defines the `sso_integration` settings for a client.
Stage is used to customize thresholds for limiting suspicious traffic in login and sign up flows.
SuspiciousIPThrottling blocks traffic from any IP address that rapidly attempts too many logins or signups.
Tenant represents an Auth0 Tenant.
TenantChangePassword holds settings for the change password page.
TenantDeviceFlow holds settings for the device flow.
TenantErrorPage holds settings for the error page.
TenantFlags holds information on flag toggles.
TenantGuardianMFAPage holds settings for guardian mfa page.
TenantMTLSConfiguration hold settings for mTLS.
TenantSessionCookie manages behavior of the tenant's session cookie, accepts either 'persistent' or 'non-persistent'.
TenantSessions manages sessions related settings for the tenant.
TenantUniversalLogin holds universal login settings.
TenantUniversalLoginColors holds universal login color settings.
Ticket is used for a users' email verification or password change.
TLSClientAuth defines the `tls_client_auth` client authentication method settings for the client.
User represents an Auth0 user resource.
UserBlock keeps track of a blocked IP for the login identifier associated with a User.
UserEnrollment contains information about the Guardian enrollments for the user.
UserIdentity holds values that validate a User's identity.
UserIdentityLink contains the data needed for linking an identity to a given user.
UserList is an envelope struct which is used when calling List() or Search() methods.
UserRecoveryCode represents a User's multi-factor authentication recovery code.
WAMSClientAddon defines the `wams` settings for a client.
WSFEDClientAddon is an empty struct used to indicate that the WS-FED Addon should be enabled.
ZendeskClientAddon defines the `zendesk` settings for a client.
ZoomClientAddon defines the `zoom` settings for a client.

# Interfaces

ConnectionOptionsScoper is used to enforce being able to read and set scopes through the scope tag on connection options properties.
Error is an interface describing any error which could be returned by the Auth0 Management API.
RequestOption configures a call (typically to retrieve a resource) to Auth0 with query parameters.

# Type aliases

ActionManager manages Auth0 Action resources.
ActionTestPayload is used for testing Actions prior to being deployed.
AnomalyManager manages Auth0 Anomaly resources.
AttackProtectionManager manages Auth0 Attack Protection settings.
BlacklistManager manages Auth0 BlacklistToken resources.
BrandingManager manages Auth0 Branding resources.
BrandingThemeManager manages Auth0 BrandingTheme resources.
ClientGrantManager manages Auth0 ClientGrant resources.
ClientManager manages Auth0 Client resources.
ConnectionManager manages Auth0 Connection resources.
CustomDomainManager manages Auth0 CustomDomain resources.
EmailProviderManager manages the Auth0 EmailProvider.
EmailTemplateManager manages Auth0 EmailTemplate resources.
EnrollmentManager manages Auth0 MultiFactor enrollment resources.
GrantManager manages Auth0 Grant resources.
HookManager manages Auth0 Hook resources.
HookSecrets are the secret keys and values associated with a Hook.
JobManager manages Auth0 Job resources.
LogManager manages Auth0 Log resources.
LogStreamManager manages Auth0 LogStream resources.
MultiFactorDUO is used for Duo MFA.
MultiFactorEmail is used for Email MFA.
MultiFactorOTP is used for OTP MFA.
MultiFactorPhone is used to manage Phone MFA.
MultiFactorPolicies policies for MultiFactor authentication.
MultiFactorPush is used for Push MFA.
MultiFactorRecoveryCode is used for RecoveryCode MFA.
MultiFactorSMS is used for SMS MFA.
MultiFactorWebAuthnPlatform is used for WebAuthnPlatform MFA.
MultiFactorWebAuthnRoaming is used for WebAuthnRoaming MFA.
Option is used for passing options to the Management client.
OrganizationManager is used for managing an Organization.
PromptManager is used for managing a Prompt.
PromptType defines the prompt that we are managing.
ResourceServerManager is used for managing a ResourceServer.
RoleManager manages Auth0 Role resources.
RuleConfigManager manages Auth0 RuleConfig resources.
RuleManager manages Auth0 Rule resources.
SelfServiceProfileManager manages Auth0 Self Service Profile resources.
SigningKeyManager manages Auth0 SigningKey resources.
StatManager manages Auth0 DailyStat resources.
TenantManager manages Auth0 Tenant resources.
TicketManager manages Auth0 Ticket resources.
UserManager manages Auth0 User resources.