Orgs Groups APIs
The API is available for customers using the new user management experience only. How the new user management experience works
Returns a list of groups within an organization, offering search functionality through multiple parameters for more precise results.
string
Requiredarray<string>
GroupNames
string
integer
array<string>
Organization found. Response contains group search results
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/groups/search' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"limit": 20
}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "example",
"description": "example description"
}
],
"links": {
"next": "MDNlZWRmNzMtMWYwMi00NGM5LWI4NjgtZGQ1NTIwMjIwYjhj",
"self": "MDI0MzkwOGEtMmYyOC00NzgzLWI5YTktMDUwZTExNzJjZDU4"
}
}Returns a page of groups in an organization that match the supplied parameters.
string
Requiredstring
Requiredstring
integer
array<string>
array<string>
array<string>
array<string>
array<string>
string
object
array<object>
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/groups' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"data": [
{
"id": "12345678-1234-1234-1234-123456789012",
"name": "jira-administrators",
"description": "This group provides admin access to Jira.",
"directoryId": "12345678-1234-1234-1234-123456789012",
"counts": {
"users": 10,
"resources": 109
},
"links": {
"self": "ECg53CukK1twBo0LK1u9nw"
}
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}Returns group stats for the organization.
string
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/groups/stats' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
{
"types": [
{
"type": "GROUP",
"count": 10
}
],
"totals": {
"all": 10,
"synced": 4
}
}Returns the details of a group.
string
Requiredstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"data": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "jira-administrators",
"description": "This group provides admin access to Jira.",
"directoryId": "12345678-1234-1234-1234-123456789012",
"links": {
"self": "ECg53CukK1twBo0LK1u9nw"
}
}
}Returns a page of role assignments for a group that match the supplied parameters.
string
Requiredstring
Requiredstring
Requiredstring
integer
array<string>
array<string>
array<string>
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"data": [
{
"resourceId": "ari:cloud:jira-core::site/1",
"resourceOwner": "jira-core",
"roles": [
"atlassian/user",
"atlassian/admin"
]
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}Rate this page: