Atlassian · Schema

SharePermissionInputBean

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
accountId string The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.
groupId string The ID of the group, which uniquely identifies the group across all Atlassian products.For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. Cannot be provided with `groupname`.
groupname string The name of the group to share the filter with. Set `type` to `group`. Please note that the name of a group is mutable, to reliably identify a group use `groupId`.
projectId string The ID of the project to share the filter with. Set `type` to `project`.
projectRoleId string The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in.
rights integer The rights for the share permission.
type string The type of the share permission.Specify the type as follows: * `user` Share with a user. * `group` Share with a group. Specify `groupname` as well. * `project` Share with a project. Specify `projectI
View JSON Schema on GitHub

JSON Schema

atlassian-sharepermissioninputbean-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SharePermissionInputBean",
  "title": "SharePermissionInputBean",
  "additionalProperties": false,
  "properties": {
    "accountId": {
      "description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.",
      "type": "string"
    },
    "groupId": {
      "description": "The ID of the group, which uniquely identifies the group across all Atlassian products.For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. Cannot be provided with `groupname`.",
      "type": "string"
    },
    "groupname": {
      "description": "The name of the group to share the filter with. Set `type` to `group`. Please note that the name of a group is mutable, to reliably identify a group use `groupId`.",
      "type": "string"
    },
    "projectId": {
      "description": "The ID of the project to share the filter with. Set `type` to `project`.",
      "type": "string"
    },
    "projectRoleId": {
      "description": "The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in.",
      "type": "string"
    },
    "rights": {
      "description": "The rights for the share permission.",
      "format": "int32",
      "type": "integer"
    },
    "type": {
      "description": "The type of the share permission.Specify the type as follows:\n\n *  `user` Share with a user.\n *  `group` Share with a group. Specify `groupname` as well.\n *  `project` Share with a project. Specify `projectId` as well.\n *  `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well.\n *  `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.\n *  `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.",
      "enum": [
        "user",
        "project",
        "group",
        "projectRole",
        "global",
        "authenticated"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}