Atlassian · Schema

PermissionScheme

Details of a permission scheme.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
description	string	A description for the permission scheme.
expand	string	The expand options available for the permission scheme.
id	integer	The ID of the permission scheme.
name	string	The name of the permission scheme. Must be unique.
permissions	array	The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.
scope	object	The scope of the permission scheme.
self	string	The URL of the permission scheme.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PermissionScheme",
  "title": "PermissionScheme",
  "additionalProperties": true,
  "description": "Details of a permission scheme.",
  "properties": {
    "description": {
      "description": "A description for the permission scheme.",
      "type": "string"
    },
    "expand": {
      "description": "The expand options available for the permission scheme.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the permission scheme.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "name": {
      "description": "The name of the permission scheme. Must be unique.",
      "type": "string"
    },
    "permissions": {
      "description": "The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.",
      "items": {
        "$ref": "#/components/schemas/PermissionGrant"
      },
      "type": "array"
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the permission scheme."
    },
    "self": {
      "description": "The URL of the permission scheme.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}