Documentation Index Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
The event object for the custom-phone-provider Actions trigger provides contextual information about the trigger execution.
event.clientInformation about the Client with which this login transaction was initiated. The client id of the application the user is logging in to.
An object for holding other application properties.
The name of the application (as defined in the Dashboard).
event.connectionDetails about the Connection that was used to authenticate the user. Hide connection properties
The connection’s unique identifier.
Metadata associated with the connection.
The name of the connection used to authenticate the user (such as twitter or some-g-suite-domain).
The type of connection. For social connections, event.connection.strategy === event.connection.name. For enterprise connections, the strategy is waad (Windows Azure AD), ad (Active Directory/LDAP), auth0 (database connections), and so on.
event.custom_domainDetails about the custom domain associated with the current transaction. Hide custom_domain properties
Custom domain metadata as key-value pairs.
event.notificationHide notification properties
The text, as we rendered it, ready to be delivered as a text message.
The text, as we rendered it, ready to be delivered as a voicetext message.
The One Time Password that we drawn for this message for some types (e.g. otp_verify, otp_enroll). If provided, it is important to have it conveyed to the end-user.
The way the message should be delivered. Could be text or voice. Allowed values: text, voice
The E.164 compliant phone number for the sender.
The locale we rendered the message in, example en_US, as defined in the BCP-47 specification.
The type of message that is being send, like otp_verify or blocked_account. Allowed values: otp_verify, otp_enroll, blocked_account, change_password, password_breach
The E.164 compliant phone number for the recipient.
event.organizationDetails about the Organization associated with the current transaction. Hide organization properties
The Organization identifier.
The friendly name of the Organization.
Metadata associated with the Organization.
The name of the Organization.
event.requestDetails about the request that initiated the transaction. The hostname that is being used for the authentication flow.
The originating IP address of the request.
The language requested by the browser.
The HTTP method used for the request
The value of the User-Agent header received when initiating the transaction.
event.secretsSecret values securely associated with this Action.
event.tenantThe friendly name for the tenant, usually a more human-readable version of the ID.
The home URL for the tenant, if defined and as found in its settings.
The logo URL for the tenant, if defined and as found in its settings.
The email to the tenant’s support service, if defined and as found in its settings.
The url to the tenant’s support service, if defined and as found in its settings.
event.transactionDetails about the current transaction for tracing purposes. Hide transaction properties
A unique identifier to correlate this request across multiple services for distributed tracing.
event.userAn object describing the user on whose behalf the current transaction was initiated. Custom fields that store info about a user that influences the user’s access, such as support plan, security roles, or access control groups.
Timestamp indicating when the user profile was first created.
(unique) User’s email address.
Indicates whether the user has verified their email address.
Timestamp indicating the last time the user’s password was reset/changed. At user creation, this field does not exist. This property is only available for Database connections.
Indicates whether the user has verified their phone number.
Timestamp indicating when the user’s profile was last updated/modified.
(unique) User’s unique identifier.
Custom fields that store info about a user that does not impact what they can or cannot access, such as work address, home address, or user preferences.
(unique) User’s username.
Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider. Hide identities properties
Name of the Auth0 connection used to authenticate the user.
Indicates whether the connection is a social one.
User information associated with the connection. When profiles are linked, it is populated with the associated user info for secondary accounts.
Name of the entity that is authenticating the user, such as Facebook, Google, SAML, or your own provider.
User’s unique identifier for this connection/provider.
