Orgs Users APIs
Return a page of users in an organization that match the supplied parameters.
Use searchTerm for free-text search across user display names and email addresses. Use emails for exact-match filtering by full email addresses. searchTerm and emails are mutually exclusive. Providing both in the same request returns 400 Bad Request. Use the expand field to include additional fields such as platformRoles, counts.resources, productAccess, and groups in the response.
string
Requiredstring
Requiredstring
integer
array<string>
array<string>
array<string>
array<string>
boolean
string
array<string>
array<string>
Success
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/users/search' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"searchTerm": "alice",
"limit": 50
}'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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"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",
"managementSource": "invited",
"mfaEnabled": true,
"jobTitle": "Senior Business Analyst",
"department": "Human Resources",
"organization": "Talent",
"location": "New York",
"timeZone": "America/New_York",
"counts": {
"resources": 10
},
"productAccess": [
{
"key": "confluence",
"id": "ari:cloud:confluence::site/12345678-1234-1234-1234-123456789012",
"lastActiveTimestamp": "2025-11-06T23:07:29.936941226Z"
}
],
"groups": [
{
"id": "ari:cloud:identity::group/12345678-1234-1234-1234-123456789012",
"name": "Engineering",
"description": "All engineers at the company"
}
],
"links": {
"self": "ECg53CukK1twBo0LK1u9nw"
}
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}Returns detailed information about a specific user in a directory within an organization.
string
Requiredstring
Requiredstring
RequiredSuccess
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/users/{userId}' \
--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
{
"data": {
"accountId": "12345678-1234-1234-1234-123456789012",
"accountType": "atlassian",
"status": "active",
"accountStatus": "active",
"membershipStatus": "active",
"addedToOrg": "2024-01-01T00:00:00.000Z",
"deactivatedOn": "2024-01-02T00: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",
"managementSource": "invited",
"mfaEnabled": true,
"jobTitle": "Senior Business Analyst",
"department": "Human Resources",
"organization": "Talent",
"location": "New York",
"timeZone": "America/New_York",
"counts": {
"resources": 10
}
}
}Returns a list of managed accounts in an organization.
Authorization scopes required: read:accounts:admin
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>"
}
}Invite people to your organization. When you invite someone:
sendNotification field is set to true and the notificationText field contains a message to include in the email invitation.This API is only available to customers who have at least one paid subscription in their organization.
string
Requiredarray<string>
Requiredarray<MultidirectoryInviteRoleAssociation>
array<string>
boolean
string
Success
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request POST \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/users/invite' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"emails": [
"<string>"
],
"permissionRules": [
{
"resource": "ari:cloud:jira::site/70ef3a32-d0da-4e09-b35e-0109f91969c3",
"role": "atlassian/user"
}
],
"additionalGroups": [
"<string>"
],
"sendNotification": true,
"notificationText": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"data": [
{
"id": "<string>",
"email": "<string>",
"results": [
{
"roleAssignmentResult": [
{}
],
"groupAssignmentResult": [
{}
]
}
]
}
]
}Returns a page of role assignments for a user that match the supplied parameters.
Authorization scopes required: read:directories:admin
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
20
21
22
23
24
25
26
27
28
{
"data": [
{
"resourceId": "ari:cloud:jira-core::site/1",
"resourceOwner": "jira-core",
"roles": [
"atlassian/org-admin",
"atlassian/site-admin",
"atlassian/user-access-admin"
],
"roleAssignments": [
{
"role": "atlassian/user-access-admin",
"roleAssignmentMethods": [
"group_direct"
]
}
],
"directoryId": "<string>",
"userDirectoryStatus": "active"
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}This API can be used to grant Platform Roles to a user.
string
Requiredstring
Requiredstring
Requiredstring
Role Assigned Successfully.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users/{userId}/roles/assign' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"role": "atlassian/user",
"resource": "ari:cloud:platform::site/70ef3a32-d0da-4e09-b35e-0109f91969c3"
}'This API can be used to revoke Platform Roles from a user.
string
Requiredstring
Requiredstring
Requiredstring
Role Revoked Successfully.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users/{userId}/roles/revoke' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"role": "atlassian/user",
"resource": "ari:cloud:platform::site/70ef3a32-d0da-4e09-b35e-0109f91969c3"
}'Suspend a user’s access in a directory to remove their access to apps temporarily. You’re not billed for a user when their access is suspended. They regain their roles and group memberships when you restore their access.
string
Requiredstring
Requiredstring
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/suspend' \
--header 'Authorization: Bearer <access_token>'Restore a user’s access in a directory to let them access apps again. They regain their roles and group memberships from before their access was suspended. We resume billing you for this user.
string
Requiredstring
Requiredstring
RequiredSuccess
1
2
3
curl --request POST \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/restore' \
--header 'Authorization: Bearer <access_token>'Remove a user from a directory if you don’t want them to appear in your directory or have access to your apps anymore. You’re not billed for a user once they’re removed. You must invite the user to your organization again if you want to reinstate their access to your apps. You’ll need to assign their roles and group memberships again.
string
Requiredstring
Requiredstring
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}' \
--header 'Authorization: Bearer <access_token>'Assign an organization-level role to a user. These are roles that have organization-wide privileges, like organization admin.
This operation follows eventual consistency. Changes may take up to 30 seconds to be reflected after the operation is performed.
string
Requiredstring
Requiredstring
RequiredSuccess.
1
2
3
4
5
6
7
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users/{userId}/role-assignments/assign' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"role": "atlassian/org-admin"
}'Remove an organization-level role from a user. These are roles that have organization-wide privileges, like organization admin.
This operation follows eventual consistency. Changes may take up to 30 seconds to be reflected after the operation is performed.
string
Requiredstring
Requiredstring
RequiredSuccess.
1
2
3
4
5
6
7
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users/{userId}/role-assignments/revoke' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"role": "atlassian/org-admin"
}'Returns a count of users in an organization that match the supplied parameters. By default, users in all your directories and all your managed accounts are counted (including managed accounts that aren’t in a directory).
To count users in a directory only, use the directoryIds field. To count your managed accounts, regardless if they’re in a directory or not, use the claimStatus field.
string
Requiredstring
Requiredarray<string>
array<string>
array<string>
array<string>
boolean
string
array<string>
array<string>
array<string>
array<string>
Success
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/directories/{directoryId}/users/count' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
{
"count": 48
}Return user stats for the organization.
Authorization scopes required: read:directories:admin
string
Requiredstring
RequiredSuccess
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
}
]
}Additional response parameters of the API (for e.g., added_to_org) are available only to customers using the new user management experience. Learn more about the new user management experience.
Specifications:
product_access response field will be empty.Learn the fastest way to call the API with a detailed tutorial.
string
Requiredstring
Requiredstring
Successful operation
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates' \
--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": {
"product_access": [
{
"id": "<string>",
"key": "jira-software",
"last_active": "<string>",
"last_active_timestamp": "<string>"
}
],
"added_to_org": "<string>",
"added_to_org_timestamp": "<string>"
},
"links": {
"next": "<string>"
}
}This API is deprecated and will no longer work after June 30, 2027. Use the Search for users in an organization endpoint instead.
Return a page of users in your organization that match the supplied parameters. By default, returns users in all your directories.
To get users in a directory only, use the directoryIds field. To get your managed accounts, regardless if they’re in a directory or not, use the claimStatus field.
Authorization scopes required: read:directories:admin
string
Requiredstring
Requiredstring
integer
array<string>
array<string>
array<string>
array<string>
boolean
string
array<string>
array<string>
Success
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"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",
"managementSource": "invited",
"mfaEnabled": true,
"jobTitle": "Senior Business Analyst",
"department": "Human Resources",
"organization": "Talent",
"location": "New York",
"timeZone": "America/New_York",
"counts": {
"resources": 10
},
"productAccess": [
{
"key": "confluence",
"id": "ari:cloud:confluence::site/12345678-1234-1234-1234-123456789012",
"lastActiveTimestamp": "2025-11-06T23:07:29.936941226Z"
}
],
"groups": [
{
"id": "ari:cloud:identity::group/12345678-1234-1234-1234-123456789012",
"name": "Engineering",
"description": "All engineers at the company"
}
],
"links": {
"self": "ECg53CukK1twBo0LK1u9nw"
}
}
],
"links": {
"self": "ObSbZxpM1f1fzia2_GnuJw",
"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
"next": "kloHX1ZQVasDAkx_P48NYQ"
}
}Rate this page: