Skip to content

UserAccount ​

Type: schema

Description ​

A shopper's user account: the storefront user profile, the customer it belongs to (customer_id, when it has one) and whether it can sign in.

TypeScript Definition ​

typescript
UserAccount: {components["schemas"]["User"] & {
            /** @description `false` once the account has been deactivated: it can no longer sign in. */
            is_active: boolean
}

Component References ​

ReferenceResolves To
components["schemas"]["User"]User

OpenAPI Schema ​

json
{
  "title": "UserAccount",
  "description": "A shopper's user account: the storefront user profile, the customer it belongs to (`customer_id`, when it has one) and whether it can sign in.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/UserAccount",
    "description": "API reference for the UserAccount schema"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/User"
    },
    {
      "type": "object",
      "properties": {
        "is_active": {
          "description": "`false` once the account has been deactivated: it can no longer sign in.",
          "type": "boolean"
        },
        "status": {
          "description": "`inactive` once the account has been deactivated, else `active`.",
          "type": "string",
          "enum": [
            "active",
            "inactive"
          ]
        }
      },
      "required": [
        "is_active",
        "status"
      ]
    }
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: