VTEX · Schema

PolicyGetResponse

Object with policy information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	Policy ID.
name	string	Policy name.
description	string	Policy description, only for internal use.
statements	array	Requirements for the policy to be applied.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PolicyGetResponse",
  "title": "PolicyGetResponse",
  "description": "Object with policy information.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "id",
      "description": "Policy ID."
    },
    "name": {
      "type": "string",
      "description": "Policy name.",
      "title": "name",
      "example": "id"
    },
    "description": {
      "type": "string",
      "description": "Policy description, only for internal use.",
      "title": "description"
    },
    "statements": {
      "type": "array",
      "title": "statements",
      "items": {
        "$ref": "#/components/schemas/StatementGetResponse"
      },
      "description": "Requirements for the policy to be applied."
    }
  }
}