Atlassian: Add user to group
Atlassian groups.addUserToGroup: arguments, response, policy and SDK examples.
← Groups operations · Get started
Operation atlassian.addusertogroup
Provider route: POST /{cloudId}/rest/api/3/group/user. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AtlassianIntegration } from "@alter-ai/atlassian";
async function execute(input: Parameters<AtlassianIntegration["groups"]["addUserToGroup"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.groups.addUserToGroup(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_atlassian import AtlassianIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.groups.add_user_to_group(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.cloudId | string | Required within parent | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
query | object | Optional | Additional keys: not allowed |
query.groupname | string | Optional | |
query.groupId | string | Optional | |
body | Model | Required within parent | Expand Add user to group — request body — body |
Referenced models: Add user to group — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get group — response body |
Referenced models: Get group — response body
Schemas
Section titled “Schemas”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
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. |
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
Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. |
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 | |
accountType | JSON | Optional | |
accountType (anyOf 1) | string | Alternative | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) Read only: true |
accountType (anyOf 2) | null | Alternative | |
active | JSON | Optional | |
active (anyOf 1) | boolean | Alternative | Whether the user is active. Read only: true |
active (anyOf 2) | null | Alternative | |
avatarUrls | JSON | Optional | |
avatarUrls (anyOf 1) | Model | Alternative | Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The avatars of the user. Read only: true |
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 settings, this may return an alternative value. Read only: true |
displayName (anyOf 2) | null | Alternative | |
emailAddress | JSON | Optional | |
emailAddress (anyOf 1) | string | Alternative | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. Read only: true |
emailAddress (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
key (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the user. Read only: true |
self (anyOf 2) | null | Alternative | |
timeZone | JSON | Optional | |
timeZone (anyOf 1) | string | Alternative | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. Read only: true |
timeZone (anyOf 2) | null | Alternative |
Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48
Get user — response body — 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 item's 16x16 pixel avatar. Format: uri |
16x16 (anyOf 2) | null | Alternative | |
24x24 | JSON | Optional | |
24x24 (anyOf 1) | string | Alternative | The URL of the item's 24x24 pixel avatar. Format: uri |
24x24 (anyOf 2) | null | Alternative | |
32x32 | JSON | Optional | |
32x32 (anyOf 1) | string | Alternative | The URL of the item's 32x32 pixel avatar. Format: uri |
32x32 (anyOf 2) | null | Alternative | |
48x48 | JSON | Optional | |
48x48 (anyOf 1) | string | Alternative | The URL of the item's 48x48 pixel avatar. Format: uri |
48x48 (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.addusertogroup. Catalog operation: addusertogroup. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["manage:jira-configuration"]