The Teamwork Graph API is available through Forge's Early Access Program (EAP).
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.
You must only install apps that call the Teamwork Graph API in test organizations. Apps calling
the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph
data across your entire organization. While apps still respect end-user permissions, this scope may
grant access to sensitive information. For safety, only install these apps in organizations with test
data. Do not install apps using this API in organizations with production data while this feature is in EAP.
Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.
You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.
Represents a group in the Atlassian Identity system. Groups are collections of users that can be used for permissions, access control, and organizational structure.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Atlassian Group.
| Field | Type | Description |
|---|---|---|
description | String | Description of the group's purpose or membership criteria. |
id | ID! | Unique identifier for the identity group. This ID is globally unique across the entire Teamwork Graph. |
name | String | Name of the group. |
The following relationships are currently supported for Atlassian Group:
Relationships where Atlassian Group is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian group can view Confluence space | Atlassian Group | Confluence space |
Rate this page: