External DocumentationTo learn more, visit the Atlassian Organizations documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Account IDs | Select the user account IDs to filter the results by. Maximum of 10 account IDs can be provided. |
| Cursor | A token used to specify a results page. This value can be obtained from the links.next property from a previous response. |
| Directory ID | The unique ID of the organization to list groups for. Can be obtained by using the List Organizations action.Note: Use the - character to retrieve all directories. |
| Directory IDs | Select the directory IDs to filter by. Maximum of 10 directory IDs can be provided.Note: The requestor must have administrative permissions for all resources linked to these directories. |
| Group IDs | Select the group IDs to filter results by. Maximum of 10 group IDs can be provided. |
| Limit | The maximum number of results to return per page. Maximum value is 100. |
| Organization ID | The unique ID of your organization. Can be obtained by using the List Organizations action. |
| Resource IDs | A comma-separated list of resource IDs in Atlassian Resource Identifier (ARI) format to filter results by. Maximum of 20 resource IDs can be provided.For Example: ari:cloud:jira-core::site/1. |
| Resource Owners | A comma-separated list of resource owners to filter results by. Maximum of 10 resource owners can be provided. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Role IDs | The role IDs to filter results by. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Include Resources Count | Select to include the number of resources associated with each group. |
| Include Users Count | Select to include the number of users associated with each group. |
| Search Term | Filter results by the value of the name property. |
| Sort By | The field and direction to sort the results by. Currently, only sorting by name is supported.Available directions: asc, descNote: If not provided, asc will be used.For Example: |
Example Output
{
"data": [
{
"id": "12345678-1234-1234-1234-123456789012",
"name": "jira-administrators",
"description": "This group provides admin access to Jira.",
"directoryId": "12345678-1234-1234-1234-123456789012",
"managementAccess": {
"deletable": true,
"modifiable": true,
"readable": true
},
"externalSynced": true,
"managedBy": "external",
"counts": {
"users": 10,
"resources": 109
},
"links": {
"self": "ECg53CukK1twBo0LK1u9nw"
}
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}
Workflow Library Example
List Organization Groups with Atlassian Organizations and Send Results Via Email