SharePermission

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SharePermission",
  "title": "SharePermission",
  "additionalProperties": false,
  "description": "Details of a share permission for the filter.",
  "properties": {
    "group": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        }
      ],
      "description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
    },
    "id": {
      "description": "The unique identifier of the share permission.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "project": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Project"
        }
      ],
      "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`.  \nFor a request, specify the `id` for the project."
    },
    "role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectRole"
        }
      ],
      "description": "The project role that the filter is shared with.  \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
    },
    "type": {
      "description": "The type of share permission:\n\n *  `user` Shared with a user.\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
      "enum": [
        "user",
        "group",
        "project",
        "projectRole",
        "global",
        "loggedin",
        "authenticated",
        "project-unknown"
      ],
      "type": "string"
    },
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBean"
        }
      ],
      "description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}