Atlassian: Filter sharing schemas
6 Atlassian schemas with complete fields and constraints.
← Filter sharing operations · All schemas
Add share permission — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
accountId | string | Optional | The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user. |
groupId | string | Optional | 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 | Optional | 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 | Optional | The ID of the project to share the filter with. Set `type` to `project`. |
projectRoleId | string | Optional | 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 | Optional | The rights for the share permission. Format: int32 |
type | string | Required within parent | 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 `projectId` as well. * `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well. * `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. * `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. One of: user, project, group, projectRole, global, authenticated |
Get default share scope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the scope of the default sharing for new filters and dashboards. |
scope | JSON | Optional | |
scope (anyOf 1) | string | Alternative | The scope of the default sharing for new filters and dashboards: * `AUTHENTICATED` Shared with all logged-in users. * `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response. * `PRIVATE` Not shared with any users. Known values: GLOBAL, AUTHENTICATED, PRIVATE |
scope (anyOf 2) | null | Alternative |
Get share permission — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a share permission for the filter. |
group | JSON | Optional | |
group (anyOf 1) | Model | Alternative | Expand Get user groups — response body — item 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. |
group (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The unique identifier of the share permission. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
project | JSON | Optional | |
project (anyOf 1) | Model | Alternative | Expand Get project — response body 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`. For a request, specify the `id` for the project. |
project (anyOf 2) | null | Alternative | |
role | JSON | Optional | |
role (anyOf 1) | Model | Alternative | Expand Create project role — response body The project role that the filter is shared with. For 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. |
role (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `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`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request. Known values: user, group, project, projectRole, global, loggedin, authenticated, project-unknown |
type (anyOf 2) | null | Alternative | |
user | JSON | Optional | |
user (anyOf 1) | Model | Alternative | Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user. |
user (anyOf 2) | null | Alternative |
Referenced models: Get user groups — response body — item, Get project — response body, Create project role — response body, Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self
Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | JSON | Optional | |
accountId (anyOf 1) | string | Alternative | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128 |
accountId (anyOf 2) | null | Alternative | |
active | JSON | Optional | |
active (anyOf 1) | boolean | Alternative | Whether the user is active. |
active (anyOf 2) | null | Alternative | |
avatarUrls | JSON | Optional | |
avatarUrls (anyOf 1) | Model | Alternative | Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48 The avatars of the user. |
avatarUrls (anyOf 2) | null | Alternative | |
displayName | JSON | Optional | |
displayName (anyOf 1) | string | Alternative | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
displayName (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The key of the user. |
key (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The username of the user. |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the user. Format: uri |
self (anyOf 2) | null | Alternative |
Referenced models: Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48
Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
16x16 | JSON | Optional | |
16x16 (anyOf 1) | string | Alternative | The URL of the user's 16x16 pixel avatar. Format: uri |
16x16 (anyOf 2) | null | Alternative | |
24x24 | JSON | Optional | |
24x24 (anyOf 1) | string | Alternative | The URL of the user's 24x24 pixel avatar. Format: uri |
24x24 (anyOf 2) | null | Alternative | |
32x32 | JSON | Optional | |
32x32 (anyOf 1) | string | Alternative | The URL of the user's 32x32 pixel avatar. Format: uri |
32x32 (anyOf 2) | null | Alternative | |
48x48 | JSON | Optional | |
48x48 (anyOf 1) | string | Alternative | The URL of the user's 48x48 pixel avatar. Format: uri |
48x48 (anyOf 2) | null | Alternative |
Set default share scope — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the scope of the default sharing for new filters and dashboards. Additional keys: not allowed |
scope | string | Required within parent | The scope of the default sharing for new filters and dashboards: * `AUTHENTICATED` Shared with all logged-in users. * `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response. * `PRIVATE` Not shared with any users. One of: GLOBAL, AUTHENTICATED, PRIVATE |