VTEX · Schema

RoleItems

Object with information about a role.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	integer	ID of the role.
isAdmin	boolean	Defines if the role has administrative access (`true`) or not (`false`).
roleType	integer	Returns `1` for custom roles, and `0` for predefined roles.
products	array	Array of License Manager product objects.
resources	string	Resources.
logins	string	Logins.
name	string	Name of the role.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RoleItems",
  "title": "RoleItems",
  "description": "Object with information about a role.",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the role.",
      "type": "integer"
    },
    "isAdmin": {
      "description": "Defines if the role has administrative access (`true`) or not (`false`).",
      "type": "boolean"
    },
    "roleType": {
      "description": "Returns `1` for custom roles, and `0` for predefined roles.",
      "type": "integer"
    },
    "products": {
      "type": "array",
      "description": "Array of License Manager product objects.",
      "items": {
        "$ref": "#/components/schemas/ProductItems"
      }
    },
    "resources": {
      "type": "string",
      "description": "Resources.",
      "nullable": true,
      "deprecated": true
    },
    "logins": {
      "type": "string",
      "description": "Logins.",
      "nullable": true,
      "deprecated": true
    },
    "name": {
      "description": "Name of the role.",
      "type": "string"
    }
  }
}