VTEX · Schema

UserItems

Object with information about an user.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	ID of the user.
email	string	Email of the user.
isAdmin	boolean	Defines if the user has administrative access (`true`) or not (`false`).
isReliable	boolean	For internal use only.
isBlocked	boolean	Defines if the user is blocked (`true`) or not (`false`).
roles	array	Array of user roles.
accountNames	array	Array of account names.
name	string	Name of the user.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserItems",
  "title": "UserItems",
  "description": "Object with information about an user.",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the user.",
      "type": "string"
    },
    "email": {
      "description": "Email of the user.",
      "type": "string"
    },
    "isAdmin": {
      "description": "Defines if the user has administrative access (`true`) or not (`false`).",
      "type": "boolean"
    },
    "isReliable": {
      "description": "For internal use only.",
      "type": "boolean"
    },
    "isBlocked": {
      "description": "Defines if the user is blocked (`true`) or not (`false`).",
      "type": "boolean"
    },
    "roles": {
      "type": "array",
      "description": "Array of user roles.",
      "items": {
        "type": "string",
        "description": "Role ID."
      }
    },
    "accountNames": {
      "type": "array",
      "description": "Array of account names.",
      "items": {
        "type": "string",
        "description": "Account names."
      }
    },
    "name": {
      "description": "Name of the user.",
      "type": "string"
    }
  }
}