Event Object

The event object for the password-reset-post-challenge Actions trigger provides contextual information about the trigger execution.

Event Object

{
  "authentication": {},
  "authorization": {
    "roles": []
  },
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "connection": {
    "id": "string",
    "name": "string",
    "strategy": "string"
  },
  "request": {
    "body": {},
    "geoip": {},
    "ip": "string",
    "method": "string",
    "query": {}
  },
  "secrets": {},
  "stats": {
    "logins_count": 0
  },
  "tenant": {
    "id": "string"
  },
  "transaction": {},
  "user": {}
}

`event.authentication`

dictionary

Details about authentication obtained during the password reset flow.

Hide event.authentication properties

array of objects

Contains the authentication methods a user has completed during their session.

object

optional

Supplemental risk assessment. This is available only if the Akamai Integration is enabled and Akamai forwards the headers for the transaction.

Hide riskAssessment properties

object

optional

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

Hide supplemental properties

object

optional

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

Hide akamai properties

object

optional

The bot detection results as forwarded by Akamai Bot Manager.

Hide akamaiBot properties

string

optional

The type of the Akamai bot manager results.

string

optional

The action of the Akamai bot manager results.

array of string

optional

The bot category of the Akamai bot manager results.

number

optional

The bot score of the Akamai bot manager results.

string

optional

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

string

optional

The botnet ID of the Akamai bot manager results.

object

optional

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

Hide akamaiUserRisk properties

string

optional

The action of the Akamai user risk assessment.

number

optional

The allowed status of the Akamai user risk assessment.

string

optional

The email domain of the user.

dictionary

optional

The general risk of the Akamai user risk assessment.

string

optional

The OUID of the user.

string

optional

The request ID of the user.

dictionary

optional

The risk of the Akamai user risk assessment.

number

optional

The score of the Akamai user risk assessment.

number

optional

The status of the Akamai user risk assessment.

dictionary

optional

The trust of the Akamai user risk assessment.

string

optional

The username of the user.

string

optional

The UUID of the Akamai user risk assessment.

`event.authorization`

object

An object containing information describing the authorization granted to the user who is logging in.

Hide event.authorization properties

array of string

An array containing the names of a user’s assigned roles.

`event.client`

object

Information about the Client with which this password reset transaction was initiated.

Hide event.client properties

string

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

dictionary

An object for holding other application properties.

string

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

`event.connection`

object

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

Hide event.connection properties

string

The connection’s unique identifier.

dictionary

optional

Metadata associated with the connection.

string

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

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`

object

optional

Details about the custom domain associated with the current transaction.

Hide event.custom_domain properties

string

The custom domain name.

dictionary

Custom domain metadata as key-value pairs.

`event.organization`

dictionary

optional

Details about the Organization associated with the current transaction.

Hide event.organization properties

string

The Organization identifier.

string

The friendly name of the Organization.

dictionary

Metadata associated with the Organization.

string

The name of the Organization.

`event.prompt`

object

optional

Collected data from rendered custom prompts.

Hide event.prompt properties

string

The prompt ID.

dictionary

optional

Fields and hidden fields data.

dictionary

optional

Shared variables data.

`event.request`

object

Details about the request that initiated the transaction.

Hide event.request properties

dictionary

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

dictionary

Hide geoip properties

string

optional

string

optional

string

optional

string

optional

string

optional

number

optional

number

optional

string

optional

string

optional

string

optional

string

optional

The hostname that is being used for the authentication flow.

string

The originating IP address of the request.

string

optional

The language requested by the browser.

string

The HTTP method used for the request

dictionary

The query string parameters sent to the authorization request.

string

optional

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

`event.secrets`

secrets

Secret values securely associated with this Action.

`event.stats`

object

Hide event.stats properties

number

The number of times this user has logged in.

`event.tenant`

object

Details about the Tenant associated with the current transaction.

Hide event.tenant properties

string

The name of the tenant.

`event.transaction`

dictionary

Details about the current transaction.

Hide event.transaction properties

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.

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).

string

optional

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

array of string

The ui_locales provided in the original authentication request.

`event.user`

dictionary

An object describing the user on whose behalf the current transaction was initiated.

Hide event.user properties

dictionary

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

Timestamp indicating when the user profile was first created.

string

optional

(unique) User’s email address.

boolean

Indicates whether the user has verified their email address.

string

optional

User’s family name.

string

optional

User’s given name.

string

optional

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.

string

optional

User’s full name.

string

optional

User’s nickname.

string

optional

User’s phone number.

boolean

optional

Indicates whether the user has verified their phone number.

string

optional

URL pointing to the user’s profile picture.

string

Timestamp indicating when the user’s profile was last updated/modified.

string

(unique) User’s unique identifier.

dictionary

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.

string

optional

(unique) User’s username.

array of objects

optional

An array of authentication factors that the user has enrolled. Empty array means the user has no enrolled factors. If enrolledFactors is undefined, the system was unable fetch the information, the user may or may not have enrolled factors.

array of objects

Contains info retrieved from the identity provider with which the user originally authenticated. 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.

Concepts

How To

Reference

Use Cases

`event.authentication`

`event.authorization`

`event.client`

`event.connection`

`event.custom_domain`

`event.organization`

`event.prompt`

`event.request`

`event.secrets`

`event.stats`

`event.tenant`

`event.transaction`

`event.user`

​event.authentication

​event.authorization

​event.client

​event.connection

​event.custom_domain

​event.organization

​event.prompt

​event.request

​event.secrets

​event.stats

​event.tenant

​event.transaction

​event.user

`event.authentication`

`event.authorization`

`event.client`

`event.connection`

`event.custom_domain`

`event.organization`

`event.prompt`

`event.request`

`event.secrets`

`event.stats`

`event.tenant`

`event.transaction`

`event.user`