Atlassian: Groups schemas
10 Atlassian schemas with complete fields and constraints.
← Groups operations · All schemas
Add user to group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
accountId | string | Optional | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128 |
name | string | Optional | This property is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
Bulk get groups — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Bulk get groups — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Bulk get groups — response body — values The list of items item
Bulk get groups — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a group. |
groupId | JSON | Optional | |
groupId (anyOf 1) | JSON | Alternative | |
groupId (anyOf 1) (anyOf 1) | string | Alternative | The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. |
groupId (anyOf 1) (anyOf 2) | null | Alternative | |
groupId (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the group. |
name (anyOf 2) | null | Alternative |
Create group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
name | string | Required within parent | The name of the group. |
Find groups — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups. |
groups | JSON | Optional | |
groups (anyOf 1) | array | Alternative | |
groups (anyOf 1)[] | Model | Each item | Expand Find groups — response body — groups array item |
groups (anyOf 2) | null | Alternative | |
header | JSON | Optional | |
header (anyOf 1) | string | Alternative | Header text indicating the number of groups in the response and the total number of groups found in the search. |
header (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The total number of groups found in the search. Format: int32 |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative |
Referenced models: Find groups — response body — groups array item
Find groups — response body — groups array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A group found in a search. |
avatarUrl | JSON | Optional | |
avatarUrl (anyOf 1) | string | Alternative | Avatar url for the group/team if present. |
avatarUrl (anyOf 2) | null | Alternative | |
groupId | JSON | Optional | |
groupId (anyOf 1) | string | Alternative | The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. |
groupId (anyOf 2) | null | Alternative | |
html | JSON | Optional | |
html (anyOf 1) | string | Alternative | The group name with the matched query string highlighted with the HTML bold tag. |
html (anyOf 2) | null | Alternative | |
labels | JSON | Optional | |
labels (anyOf 1) | array | Alternative | |
labels (anyOf 1)[] | Model | Each item | Expand Find groups — response body — groups array item labels array item |
labels (anyOf 2) | null | Alternative | |
managedBy | JSON | Optional | |
managedBy (anyOf 1) | string | Alternative | Describes who/how the team is managed. The possible values are \* external - when team is synced from an external directory like SCIM or HRIS, and team members cannot be modified. \* admins - when a team is managed by an admin (team members can only be modified by admins). \* team-members - managed by existing team members, new members need to be invited to join. \* open - anyone can join or modify this team. Known values: EXTERNAL, ADMINS, TEAM_MEMBERS, OPEN |
managedBy (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the group. The name of a group is mutable, to reliably identify a group use ``groupId`.` |
name (anyOf 2) | null | Alternative | |
usageType | JSON | Optional | |
usageType (anyOf 1) | string | Alternative | Describes the type of group. The possible values are \* team-collaboration - A platform team managed in people directory. \* userbase-group - a group of users created in adminhub. \* admin-oversight - currently unused. Known values: USERBASE_GROUP, TEAM_COLLABORATION, ADMIN_OVERSIGHT |
usageType (anyOf 2) | null | Alternative |
Referenced models: Find groups — response body — groups array item labels array item
Find groups — response body — groups array item labels array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A group label. |
text | JSON | Optional | |
text (anyOf 1) | string | Alternative | The group label name. |
text (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The title of the group label. |
title (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of the group label. Known values: ADMIN, SINGLE, MULTIPLE |
type (anyOf 2) | null | Alternative |
Get group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expand | JSON | Optional | |
expand (anyOf 1) | string | Alternative | Expand options that include additional group details in the response. Read only: true |
expand (anyOf 2) | null | Alternative | |
groupId | JSON | Optional | |
groupId (anyOf 1) | JSON | Alternative | |
groupId (anyOf 1) (anyOf 1) | string | Alternative | The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. |
groupId (anyOf 1) (anyOf 2) | null | Alternative | |
groupId (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of group. |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL for these group details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
users | JSON | Optional | |
users (anyOf 1) | Model | Alternative | Expand Get group — response body — users end-index, items, max-results, size, start-index A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 50 users, use`?expand=users[51:100]`. Read only: true |
users (anyOf 2) | null | Alternative |
Referenced models: Get group — response body — users end-index, items, max-results, size, start-index
Get group — response body — users end-index, items, max-results, size, start-index
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40. |
end-index | JSON | Optional | |
end-index (anyOf 1) | JSON | Alternative | |
end-index (anyOf 1) (anyOf 1) | integer | Alternative | The index of the last item returned on the page. Format: int32 Read only: true |
end-index (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end-index (anyOf 2) | null | Alternative | |
items | JSON | Optional | |
items (anyOf 1) | array | Alternative | The list of items. Read only: true |
items (anyOf 1)[] | Model | Each item | Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone |
items (anyOf 2) | null | Alternative | |
max-results | JSON | Optional | |
max-results (anyOf 1) | JSON | Alternative | |
max-results (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of results that could be on the page. Format: int32 Read only: true |
max-results (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max-results (anyOf 2) | null | Alternative | |
size | JSON | Optional | |
size (anyOf 1) | JSON | Alternative | |
size (anyOf 1) (anyOf 1) | integer | Alternative | The number of items on the page. Format: int32 Read only: true |
size (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size (anyOf 2) | null | Alternative | |
start-index | JSON | Optional | |
start-index (anyOf 1) | JSON | Alternative | |
start-index (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned on the page. Format: int32 Read only: true |
start-index (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start-index (anyOf 2) | null | Alternative |
Referenced models: Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone
Get users from group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone |
values (anyOf 2) | null | Alternative |
Referenced models: Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone