Policy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Policy",
  "title": "Policy",
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
      "description": "A unique identifier for the policy."
    },
    "appId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
      "description": "The `appId` of the app to which the policy applies."
    },
    "name": {
      "type": "string",
      "example": "Allow App 123",
      "description": "A user-friendly name for the policy."
    },
    "orgId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
      "description": "The `orgId` of the organization to which the policy applies."
    },
    "type": {
      "type": "string",
      "enum": [
        "default",
        "custom"
      ],
      "description": "A policy type for the policy.\n * `default` - Default policy for the org.\n * `custom` - Customized policy for an App.\n"
    },
    "personIds": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0,Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0,Y2lzY29zcGFyazovL3VzL0NBTExTLzU0MUFFMzBFLUUyQzUtNERENi04NTM4LTgzOTRDODYzM0I3MQo"
      },
      "description": "The `personIds` for the people this policy applies to."
    },
    "action": {
      "type": "string",
      "enum": [
        "allow",
        "deny"
      ],
      "description": "The policy action.\n * `allow` - Integration usage allowed.\n * `deny` - Integration usage denied.\n"
    },
    "created": {
      "type": "string",
      "example": "2017-05-10T19:39:27.970Z",
      "description": "The date and time the policy was created."
    }
  }
}