GET
/
users
/
{userId}
/
actions
/
{action}
/
{idempotencyKey}

Path Parameters

userId
string
required

The ID of the user.

action
string
required

A short human-readable code which defines the action that the user is performing, e.g. signIn. This value will be displayed in the Authsignal Portal and can be used to configure rules for authentication events with differing risk profiles. Values are validated with the following regex: ^[a-zA-Z0-9_-]{(1, 64)}$.

idempotencyKey
string
required

The unique key which identifies the particular action which was tracked.

Response

200 - application/json
createdAt
string

The time in ISO 8061 format when the action was first created via track.

output
object

The output produced by the rules engine when determining if the action requires a challenge.

priorityRuleId
string

The ID of the rule that had the highest priority and determined the state of the user action.

ruleIds
string[]

The IDs of the triggered rules.

rules
object[]

A snapshot of the triggered rules at the time the user action was tracked, ordered by priority.

state
enum<string>

The current state of the action.

Available options:
ALLOW,
BLOCK,
CHALLENGE_REQUIRED,
CHALLENGE_FAILED,
CHALLENGE_SUCCEEDED,
REVIEW_REQUIRED,
REVIEW_FAILED,
REVIEW_SUCCEEDED
stateUpdatedAt
string

The time in ISO 8061 format when the state of the action was last updated.

verificationMethod
enum<string>
Available options:
SMS,
AUTHENTICATOR_APP,
EMAIL_MAGIC_LINK,
EMAIL_OTP,
PUSH,
SECURITY_KEY,
PASSKEY,
VERIFF,
IPROOV,
PALM_BIOMETRICS_RR,
IDVERSE