Atlassian · Schema

PermissionCheckResponse

This object represents the response for the content permission check API. If the user or group does not have permissions, the following errors may be returned: - Group does not have permission to the space - Group does not have permission to the content - User is not allowed to use Confluence - User does not have permission to the space - User does not have permission to the content - Anonymous users are not allowed to use Confluence - Anonymous user does not have permission to the space - Anonymous user does not have permission to the content

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
hasPermission boolean
errors array
_links object
View JSON Schema on GitHub

JSON Schema

atlassian-permissioncheckresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PermissionCheckResponse",
  "title": "PermissionCheckResponse",
  "required": [
    "hasPermission"
  ],
  "type": "object",
  "properties": {
    "hasPermission": {
      "type": "boolean",
      "example": true
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Message"
      },
      "example": []
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  },
  "description": "This object represents the response for the content permission check API. If the user or group does not have\npermissions, the following errors may be returned:\n\n- Group does not have permission to the space\n- Group does not have permission to the content\n- User is not allowed to use Confluence\n- User does not have permission to the space\n- User does not have permission to the content\n- Anonymous users are not allowed to use Confluence\n- Anonymous user does not have permission to the space\n- Anonymous user does not have permission to the content"
}