PATCH
/
users
/
{userId}
/
actions
/
{action}
/
{idempotencyKey}
curl --request PATCH \
  --url https://api.authsignal.com/v1/users/{userId}/actions/{action}/{idempotencyKey}
{
  "state": "ALLOW",
  "createdAt": "2023-11-07T05:31:56Z",
  "stateUpdatedAt": "2023-11-07T05:31:56Z",
  "output": {
    "custom": {}
  },
  "verificationMethod": "SMS",
  "ruleIds": [
    "<string>"
  ]
}

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

OK

The response is of type object.