Returns a list of managed accounts in an organization.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Successful operation
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users' \
--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
23
24
25
26
27
28
29
30
31
32
33
{
"data": [
{
"account_id": "<string>",
"account_type": "atlassian",
"account_status": "active",
"name": "<string>",
"picture": "<string>",
"email": "<string>",
"access_billable": true,
"last_active": "<string>",
"product_access": [
{
"key": "jira-software",
"name": "<string>",
"url": "<string>",
"last_active": "<string>"
}
],
"links": {
"self": "<string>"
}
}
],
"meta": {
"total": 35
},
"links": {
"self": "<string>",
"prev": "<string>",
"next": "<string>"
}
}The API is available for customers using the new user management experience only. How the new user management experience works
Returns a list of users within an organization, offering search functionality through multiple parameters for more precise results.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredarray<string>
array<string>
array<string>
NamesOrNicknames
EmailUsernames
EmailDomains
boolean
string
integer
array<string>
Organization found. Response contains user search results
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users/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": [
{
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"accountType": "atlassian",
"accountStatus": "active"
}
],
"links": {
"next": "MDNlZWRmNzMtMWYwMi00NGM5LWI4NjgtZGQ1NTIwMjIwYjhj",
"self": "MDI0MzkwOGEtMmYyOC00NzgzLWI5YTktMDUwZTExNzJjZDU4"
}
}Returns a page of users in an organization that match the supplied parameters.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
integer
array<string>
array<string>
array<string>
array<string>
string
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}/users' \
--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
23
24
25
26
27
28
29
30
31
32
33
{
"data": [
{
"accountId": "12345678-1234-1234-1234-123456789012",
"accountType": "atlassian",
"status": "active",
"accountStatus": "active",
"membershipStatus": "active",
"addedToOrg": "2024-01-01T00:00:00.000Z",
"name": "John Doe",
"nickname": "Jonny",
"email": "email@example.com",
"emailVerified": true,
"claimStatus": "unmanaged",
"platformRoles": [
"atlassian/org-admin"
],
"picture": "https://picture.example.com/picture.png",
"avatar": "https://avatar.example.com/avatar.png",
"counts": {
"resources": 10
},
"links": {
"self": "ECg53CukK1twBo0LK1u9nw"
}
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}Returns user stats for the organization.
Forge and OAuth2 apps cannot access this REST resource.
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}/users/stats' \
--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
{
"roles": [
{
"roleId": "atlassian/org-admin",
"count": 3
}
],
"accountStatus": [
{
"status": "active",
"count": 5
},
{
"status": "inactive",
"count": 1
},
{
"status": "closed",
"count": 2
}
]
}Returns a page of role assignments for a user that match the supplied parameters.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
integer
array<string>
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}/users/{accountId}/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
18
19
{
"data": [
{
"resourceId": "ari:cloud:jira-core::site/1",
"resourceOwner": "jira-core",
"roles": [
[
"atlassian/org-admin",
"atlassian/site-admin"
]
]
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}Rate this page: