Actions Triggers: pre-user-registration - Event Object

The event object for the pre-user-registration Actions trigger provides contextual information about the trigger execution.

`event.authentication`

event.authentication

dictionary

optional

Details about authentication obtained during the pre user registration flow.

Hide authentication properties

riskAssessment

dictionary

optional

Details about risk assessments information for different flows.

Hide riskAssessment properties

supplemental

dictionary

optional

Supplemental signals sent from third party providers to assist in risk assessments.

Show supplemental properties

akamai

dictionary

optional

[Limited Early Access] Supplemental risk assessment. This is available only if Akamai Account Protector is enabled and Akamai forwards the headers for the transaction.

Show akamai properties

akamaiBot

object

optional

The bot detection results as forwarded by Akamai Bot Manager.

Show akamaiBot properties

type

string

optional

The type of the Akamai bot manager results.

action

string

optional

The action of the Akamai bot manager results.

botCategory

array of strings

optional

The bot category of the Akamai bot manager results.

botScore

number

optional

The bot score of the Akamai bot manager results.

botScoreResponseSegment

string

optional

The bot score response segment of the Akamai bot manager results.

botnetId

string

optional

The botnet ID of the Akamai bot manager results.

akamaiUserRisk

dictionary

optional

The user risk detection results as forwarded by Akamai Account Protector.

Show akamaiUserRisk properties

action

string

optional

The action of the Akamai user risk assessment.

allow

number

optional

The allowed status of the Akamai user risk assessment.

emailDomain

string

optional

The email domain of the user.

general

dictionary

optional

The general risk of the Akamai user risk assessment.

ouid

string

optional

The OUID of the user.

requestid

string

optional

The request ID of the user.

risk

dictionary

optional

The risk of the Akamai user risk assessment.

score

number

optional

The score of the Akamai user risk assessment.

status

number

optional

The status of the Akamai user risk assessment.

trust

dictionary

optional

The trust of the Akamai user risk assessment.

username

string

optional

The username of the user.

uuid

string

optional

The UUID of the Akamai user risk assessment.

`event.client`

event.client

dictionary

optional

Information about the Client with which this transaction was initiated.

Hide client properties

client_id

string

The client id of the application the user is logging in to.

metadata

dictionary

An object for holding other application properties.

name

string

The name of the application (as defined in the Dashboard).

`event.connection`

event.connection

dictionary

Details about the Connection that was used to register the user.

Hide connection properties

string

The connection’s unique identifier.

metadata

dictionary

optional

Metadata associated with the connection.

name

string

The name of the connection used to authenticate the user (such as twitter or some-g-suite-domain).

strategy

string

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_domain`

event.custom_domain

dictionary

optional

Details about the custom domain associated with the current transaction.

Hide custom_domain properties

domain

string

The custom domain name.

domain_metadata

dictionary

Custom domain metadata as key-value pairs.

`event.request`

event.request

dictionary

Details about the request that initiated the transaction.

Hide request properties

body

dictionary

The body of the POST request. This data will only be available during refresh token, Client Credential Exchange flows and PreUserRegistration Action.

geoip

dictionary

Hide geoip properties

cityName

string

optional

continentCode

string

optional

countryCode

string

optional

countryCode3

string

optional

countryName

string

optional

latitude

number

optional

longitude

number

optional

subdivisionCode

string

optional

subdivisionName

string

optional

timeZone

string

optional

hostname

string

optional

The hostname that is being used for the authentication flow.

string

The originating IP address of the request.

language

string

optional

The language requested by the browser.

method

string

The HTTP method used for the request

user_agent

string

optional

The value of the User-Agent header received when initiating the transaction.

`event.security_context`

event.security_context

object

optional

An object containing fingerprint signatures. This will be available only if the client is using cloudflare. The JA3/JA4 fingerprint can be null or empty in some cases. The most common case is for HTTP requests because JA3 and JA4 are calculated in TLS. It can also be empty due to the Worker sending requests within the same zone or to a zone that is not proxied (or a third party).

Hide security_context properties

ja3

string

optional

JA3 fingerprint signature. This will be available only if the client is using a TLS connection.

ja4

string

optional

JA4 fingerprint signature. This will be available only if the client is using a TLS connection.

`event.tenant`

event.tenant

object

Details about the Tenant associated with the current transaction.

Hide tenant properties

string

The name of the tenant.

`event.transaction`

event.transaction

dictionary

optional

Details about the current transaction.

Hide transaction properties

acr_values

array of strings

Any acr_values provided in the original authentication request.

locale

string

The locale to be used for this transaction as determined by comparing the browser’s requested languages to the tenant’s language settings.

Hint to the Authorization Server about the login identifier the End-User might use to log in (if necessary).

prompt

array of strings

optional

List of instructions indicating whether the user may be prompted for re-authentication and consent.

protocol

string

optional

Possible values:

oidc-basic-profile
oidc-ciba
oidc-ciba-web-link
oidc-implicit-profile
oauth2-device-code
oauth2-resource-owner
oauth2-resource-owner-jwt-bearer
oauth2-password
oauth2-webauthn
oauth2-access-token
oauth2-refresh-token
oauth2-token-exchange
oidc-hybrid-profile
samlp
wsfed
wstrust-usernamemixed

redirect_uri

string

optional

The URL to which Auth0 will redirect the browser after the transaction is completed.

requested_scopes

array of strings

The scopes requested (if any) when starting this authentication flow.

response_mode

string

optional

Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint.Allowed values: query, fragment, form_post, web_message

response_type

array of strings

optional

Denotes the kind of credential that Auth0 will return.

state

string

optional

An opaque arbitrary alphanumeric string your app adds to the initial request that Auth0 includes when redirecting back to your application.

ui_locales

array of strings

The ui_locales provided in the original authentication request.

correlation_id

string

optional

Correlation ID can be provided in the initial authentication request when the application redirects to Universal Login. You can use value to correlate logs and requests from your Action code with the user flow.

`event.user`

event.user

dictionary

An object describing the user who is attempting to register.

Hide user properties

app_metadata

dictionary

optional

Custom fields that store info about a user that influences the user’s access, such as support plan, security roles, or access control groups.

string

optional

(unique) User’s email address.

family_name

string

optional

User’s family name.

given_name

string

optional

User’s given name.

name

string

optional

User’s full name.

nickname

string

optional

User’s nickname.

phone_number

string

optional

User’s phone number.

picture

string

optional

URL pointing to the user’s profile picture.

user_metadata

dictionary

optional

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.

username

string

optional

(unique) User’s username.

`event.secrets`

event.secrets

secrets

Secret values securely associated with this Action.

Brand Customization

Code Customization

Third-Party Customization

Actions Triggers: pre-user-registration - Event Object

`event.authentication`

`event.client`

`event.connection`

`event.custom_domain`

`event.request`

`event.security_context`

`event.tenant`

`event.transaction`

`event.user`

`event.secrets`

Brand Customization

Code Customization

Third-Party Customization

​event.authentication

​event.client

​event.connection

​event.custom_domain

​event.request

​event.security_context

​event.tenant

​event.transaction

​event.user

​event.secrets

`event.authentication`

`event.client`

`event.connection`

`event.custom_domain`

`event.request`

`event.security_context`

`event.tenant`

`event.transaction`

`event.user`

`event.secrets`