Atlassian · Schema

SpacePermissionV2

This object represents a single space permission. Permissions consist of at least one operation object with an accompanying subjects object. The following combinations of `operation.key` and `operation.target` values are valid for the `operation` object: ``` bash 'create': 'page', 'blogpost', 'comment', 'attachment' 'read': 'space' 'delete': 'page', 'blogpost', 'comment', 'attachment', 'space' 'export': 'space' 'administer': 'space' 'archive': 'page' 'restrict_content': 'space' ``` For example, to enable Delete Own permission, set the `operation` object to the following: ``` "operation": { "key": "delete", "target": "space" } ``` To enable Add/Delete Restrictions permissions, set the `operation` object to the following: ``` "operation": { "key": "restrict_content", "target": "space" } ```

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
id	integer
subject	object
operation	object
_links	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SpacePermissionV2",
  "title": "SpacePermissionV2",
  "required": [
    "id",
    "subject",
    "operation"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": "abc123"
    },
    "subject": {
      "$ref": "#/components/schemas/PermissionSubject"
    },
    "operation": {
      "required": [
        "key",
        "target"
      ],
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "enum": [
            "administer",
            "archive",
            "copy",
            "create",
            "delete",
            "export",
            "move",
            "purge",
            "purge_version",
            "read",
            "restore",
            "restrict_content",
            "update",
            "use"
          ]
        },
        "target": {
          "type": "string",
          "description": "The space or content type that the operation applies to.",
          "enum": [
            "page",
            "blogpost",
            "comment",
            "attachment",
            "space"
          ]
        }
      },
      "example": "example_value"
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  },
  "description": "This object represents a single space permission. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation.key` and `operation.target` values are\nvalid for the `operation` object:\n``` bash\n'create': 'page', 'blogpost', 'comment', 'attachment'\n'read': 'space'\n'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'\n'export': 'space'\n'administer': 'space'\n'archive': 'page'\n'restrict_content': 'space'\n```\n\nFor example, to enable Delete Own permission, set the `operation` object to the following:\n```\n\"operation\": {\n    \"key\": \"delete\",\n    \"target\": \"space\"\n}\n```\nTo enable Add/Delete Restrictions permissions, set the `operation` object to the following:\n```\n\"operation\": {\n    \"key\": \"restrict_content\",\n    \"target\": \"space\"\n}\n```"
}