Update User Details

v1.0.0

Update the profile details for the given user

When updating Payor users with the role of payor.master_admin a verificationCode is required

Input

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "the email address of the user"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "mfaType": {
      "type": "string",
      "description": "The type of the MFA device",
      "enum": [
        "SMS",
        "YUBIKEY",
        "TOTP"
      ]
    },
    "primaryContactNumber": {
      "type": "string",
      "description": "The main contact number for the user\n"
    },
    "secondaryContactNumber": {
      "type": "string",
      "description": "The secondary contact number for the user\n"
    },
    "smsNumber": {
      "type": "string",
      "description": "The phone number of a device that the user can receive sms messages on\n"
    },
    "userId": {
      "type": "string",
      "format": "uuid"
    },
    "verificationCode": {
      "type": "string",
      "description": "<p>Optional property that MUST be suppied when manually verifying a user</p>\n<p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>\n"
    }
  },
  "required": [
    "userId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}