Skip to content

ForgotUsernameUser ​

Type: schema

Description ​

A user of the recovered account's business, as much as it takes to choose one: the name and the masked contact.

TypeScript Definition ​

typescript
ForgotUsernameUser: {{
            /** @description Pass as `user_id` to sign in as this user. */
            id: string;
            first_name: string | null;
            last_name: string | null;
            /** @description Masked: its first three characters and its domain. */
            email: string | null;
            /** @description Masked: its last four digits. */
            phone: string | null;
        };
        /**
         * ForgotUsernameWithAttribute
         * @description Deprecated: send `filters`. One attribute and its value, matched as a single filter.
         */
}

OpenAPI Schema ​

json
{
  "title": "ForgotUsernameUser",
  "description": "A user of the recovered account's business, as much as it takes to choose one: the name and the masked contact.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ForgotUsernameUser",
    "description": "API reference for the ForgotUsernameUser schema"
  },
  "required": [
    "id",
    "first_name",
    "last_name",
    "email",
    "phone"
  ],
  "properties": {
    "id": {
      "description": "Pass as `user_id` to sign in as this user.",
      "type": "string"
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "description": "Masked: its first three characters and its domain.",
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "Masked: its last four digits.",
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: