User Auth Code Requested Event (v1.1.0)

User has requested a new validation code.

Event Broker:AWS Eventbridge Recently updated!

Info

We should probably make a change to this event payload. Is there a reason to send an entire UserAccount when we wish to send a code to the user?

Overview

This event is triggered when a user requires a new code to validate. It could be that the old code has been lost, or not been delivered, or simply it is not working for what ever reason.

In the auth adapter the event will trigger the generation of a new code and also update the PAL Users database with the new code. The code is sent via AWS SES.

schema.json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UserAuthCodeRequested",
  "additionalProperties": false,
  "definitions": {
    "UserAccount": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "Id": {
          "type": "string"
        },
        "Enabled": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Status": {
          "type": "string"
        },
        "Email": {
          "type": "string"
        },
        "Groups": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Attributes": {
          "$ref": "#/definitions/Attributes"
        },
        "CreateDate": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        },
        "ModifiedDate": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        }
      }
    },
    "Attributes": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "NotificationType": {
      "type": "integer",
      "description": "",
      "x-enumNames": [
        "EmailCode",
        "SMSCode",
        "SMSUserCode",
        "Unknown"
      ],
      "enum": [
        1,
        100,
        101,
        -1
      ]
    },
    "ObjectEventDetailBase": {
      "type": "object",
      "$comment": "x-abstract: true",
      "additionalProperties": false,
      "properties": {
        "Attributes": {
          "$ref": "#/definitions/Attributes"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/ObjectEventDetailBase"
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "User": {
          "$ref": "#/definitions/UserAccount"
        },
        "CustomAuthorizationMessage": {
          "type": [
            "null",
            "string"
          ]
        },
        "CustomVerificationMessage": {
          "type": [
            "null",
            "string"
          ]
        },
        "SenderName": {
          "type": [
            "null",
            "string"
          ]
        },
        "NotificationType": {
          "$ref": "#/definitions/NotificationType"
        }
      }
    }
  ]
}

JSON Schema

14 properties
Attributesobject→ Attributes
Userobject→ UserAccount
CustomAuthorizationMessagenullstring
CustomVerificationMessagenullstring
SenderNamenullstring
NotificationTypeinteger→ NotificationType
Allowed values: 1 100 101 -1
Edit this page