package
0.9.6
Repository: https://github.com/misalud-ai/go-auth0.git
Documentation: pkg.go.dev

# Functions

Body configures a requests body.
Context configures a request to use the specified context.
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.
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.
WithClient configures management to use the provided client.
WithClientCredentials configures management to authenticate using the client credentials authentication flow.
WithContext configures the management client to use the provided context instead of the provided one.
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.
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.
ConnectionStrategyDigitalOcean constant.
ConnectionStrategyDiscord constant.
ConnectionStrategyDropbox constant.
ConnectionStrategyEmail constant.
ConnectionStrategyFacebook constant.
ConnectionStrategyFigma constant.
ConnectionStrategyGitHub constant.
ConnectionStrategyGoogleApps constant.
ConnectionStrategyGoogleOAuth2 constant.
ConnectionStrategyImgur constant.
ConnectionStrategyLinkedin constant.
ConnectionStrategyOAuth2 constant.
ConnectionStrategyOIDC constant.
ConnectionStrategyPaypal constant.
ConnectionStrategySalesforce constant.
ConnectionStrategySalesforceCommunity constant.
ConnectionStrategySalesforceSandbox constant.
ConnectionStrategySAML constant.
ConnectionStrategyShopify constant.
ConnectionStrategySlack constant.
ConnectionStrategySMS constant.
ConnectionStrategySpotify constant.
ConnectionStrategyTwitch constant.
ConnectionStrategyTwitter constant.
ConnectionStrategyVimeo constant.
ConnectionStrategyWindowsLive constant.
ConnectionStrategyWordpress constant.
ConnectionStrategyYahoo constant.
LogStreamTypeAmazonEventBridge constant.
LogStreamTypeAzureEventGrid constant.
LogStreamTypeDatadog constant.
LogStreamTypeHTTP constant.
LogStreamTypeSplunk constant.
LogStreamTypeSumo constant.

# 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.
ActionManager manages Auth0 Action resources.
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.
AnomalyManager manages Auth0 Anomaly resources.
AttackProtectionManager manages Auth0 Attack Protection settings.
BlacklistManager manages Auth0 BlacklistToken resources.
BlacklistToken is a token that has been blacklisted.
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.
BrandingManager manages Auth0 Branding resources.
BrandingPageBackgroundGradient is used to customize the background color of the Universal Login Page.
BrandingUniversalLogin is used to customize the body of the Universal Login Page.
BreachedPasswordDetection protects applications from bad actors logging in with stolen credentials.
BruteForceProtection safeguards against a single IP address attacking a single user account.
Client is an application or a sso integration.
ClientGrant is a method through which applications can gain Access Tokens.
ClientGrantList is a list of ClientGrants.
ClientGrantManager manages Auth0 ClientGrant resources.
ClientJWTConfiguration is used to configure JWT settings for our Client.
ClientList is a list of Clients.
ClientManager manages Auth0 Client resources.
ClientNativeSocialLogin is used to configure Native Social Login for our Client.
ClientRefreshToken is used to configure the Refresh Token settings for our 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.
ConnectionManager manages Auth0 Connection resources.
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.
ConnectionOptionsAzureAD is used to configure an AzureAD Connection.
ConnectionOptionsEmail is used to configure an Email Connection.
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.
ConnectionOptionsOTP is used to configure the OTP settings on a ConnectionOptionsEmail.
ConnectionOptionsSalesforce is used to configure a SalesForce Connection.
ConnectionOptionsSAML is used to configure a SAML Connection.
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.
ConnectionOptionsWindowsLive is used to configure a WindowsLive Connection.
CreateEnrollmentTicket used to create an enrollment ticket.
CustomDomain to be used on authentication pages.
CustomDomainManager manages Auth0 CustomDomain resources.
CustomDomainVerification is used to verify a CustomDomain.
DailyStat for an Auth0 Tenant.
Email is used to configure Email Providers.
EmailCredentials are used for authenticating Email Providers.
EmailManager manages Auth0 Email resources.
EmailTemplate is used to customize emails.
EmailTemplateManager manages Auth0 EmailTemplate resources.
Enrollment is used for MultiFactor Authentication.
EnrollmentManager manages Auth0 MultiFactor enrollment resources.
EnrollmentTicket holds information on the ticket ID and URL.
Grant is a way of retrieving an Access Token.
GrantList is a list of Grants.
GrantManager manages Auth0 Grant resources.
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.
HookManager manages Auth0 Hook resources.
Job is used for importing/exporting users or for sending email address verification emails.
JobManager manages Auth0 Job resources.
List is an envelope which is typically used when calling List() or Search() methods.
Log for analyzing business needs.
LogManager manages Auth0 Log resources.
LogStream is used to export tenant log events to a log event analysis service.
LogStreamManager manages Auth0 LogStream resources.
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.
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.
MultiFactor Authentication method.
MultiFactorDUO is used for Duo MFA.
MultiFactorDUOSettings holds settings for configuring DUO.
MultiFactorEmail is used for Email MFA.
MultiFactorManager manages MultiFactor Authentication options.
MultiFactorOTP is used for OTP MFA.
MultiFactorPhone is used to manage Phone MFA.
MultiFactorProvider holds provider type for MultiFactor Authentication.
MultiFactorProviderAmazonSNS is an AmazonSNS provider used for MultiFactorPush Authentication.
MultiFactorProviderTwilio is used for Twilio MultiFactor Authentication.
MultiFactorPush is used for Push MFA.
MultiFactorPushCustomApp holds custom multi-factor authentication app settings.
MultiFactorRecoveryCode is used for RecoveryCode MFA.
MultiFactorSMS is used for SMS MFA.
MultiFactorSMSTemplate holds the sms template for MultiFactor Authentication.
MultiFactorWebAuthnPlatform is used for WebAuthnPlatform MFA.
MultiFactorWebAuthnRoaming is used for WebAuthnRoaming MFA.
MultiFactorWebAuthnSettings holds settings for configuring WebAuthn Roaming or Platform.
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.
OrganizationManager is used for managing an Organization.
OrganizationMember holds member information for an Organization.
OrganizationMemberList is a list of OrganizationMembers.
OrganizationMemberRole holds member role information.
OrganizationMemberRoleList is a list of OrganizationMemberRoles.
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.
Prompt is used within the Login Page.
PromptManager is used for managing a Prompt.
ResourceServer is an entity that represents an external resource, capable of accepting and responding to protected resource requests made by applications.
ResourceServerList is a list of ResourceServers.
ResourceServerManager is used for managing a ResourceServer.
ResourceServerScope defines the specific actions, resource servers can be allowed to do.
Role is used to assign roles to a User.
RoleList holds a list of Roles.
RoleManager manages Auth0 Role resources.
Rule is used as part of the authentication pipeline.
RuleConfig are key value pairs used to configure Rules.
RuleConfigManager manages Auth0 RuleConfig resources.
RuleList holds a list of Rules.
RuleManager manages Auth0 Rule resources.
SigningKey is used for signing tokens.
SigningKeyManager manages Auth0 SigningKey resources.
Stage is used to customize thresholds for limiting suspicious traffic in login and sign up flows.
StatManager manages Auth0 DailyStat resources.
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.
TenantManager manages Auth0 Tenant resources.
TenantSessionCookie manages behavior of the tenant's session cookie, accepts either 'persistent' or 'non-persistent'.
TenantUniversalLogin holds universal login settings.
TenantUniversalLoginColors holds universal login color settings.
Ticket is used for a users' email verification or password change.
TicketManager manages Auth0 Ticket resources.
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.
UserManager manages Auth0 User resources.
UserRecoveryCode represents a User's multi-factor authentication recovery code.

# Interfaces

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

ActionTestPayload is used for testing Actions prior to being deployed.
HookSecrets are the secret keys and values associated with a Hook.
MultiFactorPolicies policies for MultiFactor authentication.
Option is used for passing options to the Management client.