Atlassian · Schema

SpacePermission

This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following combinations of `operation` and `targetType` values are valid for the `operation` object: - 'create': 'page', 'blogpost', 'comment', 'attachment' - 'read': 'space' - 'delete': 'page', 'blogpost', 'comment', 'attachment' - 'export': 'space' - 'administer': 'space'

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
id	integer
subjects	object	The users and/or groups that the permission applies to.
operation	object
anonymousAccess	boolean	Grant anonymous users permission to use the operation.
unlicensedAccess	boolean	Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SpacePermission",
  "title": "SpacePermission",
  "required": [
    "anonymousAccess",
    "operation",
    "unlicensedAccess"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": "abc123"
    },
    "subjects": {
      "type": "object",
      "properties": {
        "user": {
          "required": [
            "results",
            "size"
          ],
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/User"
              }
            },
            "size": {
              "type": "integer",
              "format": "int32"
            },
            "start": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            }
          }
        },
        "group": {
          "required": [
            "results",
            "size"
          ],
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Group"
              }
            },
            "size": {
              "type": "integer",
              "format": "int32"
            },
            "start": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            }
          }
        },
        "_expandable": {
          "type": "object",
          "properties": {
            "user": {
              "type": "string"
            },
            "group": {
              "type": "string"
            }
          }
        }
      },
      "description": "The users and/or groups that the permission applies to.",
      "example": "example_value"
    },
    "operation": {
      "$ref": "#/components/schemas/OperationCheckResult"
    },
    "anonymousAccess": {
      "type": "boolean",
      "description": "Grant anonymous users permission to use the operation.",
      "default": false,
      "example": true
    },
    "unlicensedAccess": {
      "type": "boolean",
      "description": "Grants access to unlicensed users from JIRA Service Desk when used\nwith the 'read space' operation.",
      "default": false,
      "example": true
    }
  },
  "description": "This object represents a permission for given space. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation` and `targetType` values are\nvalid for the `operation` object:\n\n  - 'create': 'page', 'blogpost', 'comment', 'attachment'\n  - 'read': 'space'\n  - 'delete': 'page', 'blogpost', 'comment', 'attachment'\n  - 'export': 'space'\n  - 'administer': 'space'"
}