Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
users

Get action

Get detailed information on a tracked action.

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

Path parameters

userIdstring required

The ID of the user.

actionstring 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)}$.

idempotencyKeystring required

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

Response

OK

state'ALLOW' | 'BLOCK' | 'CHALLENGE_REQUIRED' | 'CHALLENGE_FAILED' | 'CHALLENGE_SUCCEEDED' | 'REVIEW_REQUIRED' | 'REVIEW_FAILED' | 'REVIEW_SUCCEEDED'

The current state of the action.

createdAtstring date-time

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

stateUpdatedAtstring date-time

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

verificationMethod'SMS' | 'AUTHENTICATOR_APP' | 'EMAIL_MAGIC_LINK' | 'EMAIL_OTP' | 'PUSH' | 'DEVICE' | 'SECURITY_KEY' | 'PASSKEY' | 'VERIFF' | 'IPROOV' | 'PALM_BIOMETRICS_RR' | 'IDVERSE'
verifiedByAuthenticatorIdstring

The ID of the authenticator which was used to complete the challenge associated with the action.

priorityRuleIdstring

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

ruleIdsstring[]

The IDs of the triggered rules.