Atlassian · Schema

ContentRestrictionUpdate

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
operation string The restriction operation applied to content.
restrictions object The users/groups that the restrictions will be applied to. At least one of `user` or `group` must be specified for this object.
content object
View JSON Schema on GitHub

JSON Schema

atlassian-contentrestrictionupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentRestrictionUpdate",
  "title": "ContentRestrictionUpdate",
  "required": [
    "operation",
    "restrictions"
  ],
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "description": "The restriction operation applied to content.",
      "enum": [
        "administer",
        "copy",
        "create",
        "delete",
        "export",
        "move",
        "purge",
        "purge_version",
        "read",
        "restore",
        "update",
        "use"
      ],
      "example": "administer"
    },
    "restrictions": {
      "type": "object",
      "properties": {
        "group": {
          "type": "array",
          "description": "The groups that the restrictions will be applied to. This array must\nhave at least one item, otherwise it should be omitted. At least one of `name` or `id` is required,\nand `id` should be used where possible in advance of the `name` deprecation.",
          "items": {
            "required": [
              "type"
            ],
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "Set to 'group'.",
                "enum": [
                  "group"
                ]
              },
              "name": {
                "type": "string",
                "description": "The name of the group.",
                "deprecated": true
              },
              "id": {
                "type": "string",
                "description": "The id of the group."
              }
            },
            "description": "A group that the restriction will be applied to."
          }
        },
        "user": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/User"
              }
            },
            {
              "$ref": "#/components/schemas/UserArray"
            }
          ]
        }
      },
      "description": "The users/groups that the restrictions will be applied to. At least one of\n`user` or `group` must be specified for this object.",
      "example": "example_value"
    },
    "content": {
      "$ref": "#/components/schemas/Content"
    }
  }
}