• Orgs
  • Users
  • Groups
  • Domains
  • Events
  • Policies
  • Directory
  • Workspaces
Cloud
Organizations REST API / Reference / REST API

Users

Postman Collection
OpenAPI
GET

Get managed accounts in an organization

Returns a list of managed accounts in an organization.

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

Responses

Successful operation

application/json

UserPage
GET/v1/orgs/{orgId}/users
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'
200Response
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>" } }
POST

Search for users within an organization (available only for the new user management experience)Experimental

Returns a list of users with applied privacy controls in an organization using the new user management experience ** Learn more about the new user management experience.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

accountIds

array<string>

accountTypes

array<string>

accountStatuses

array<string>

namesOrNicknames

NamesOrNicknames

emailUsernames

EmailUsernames

emailDomains

EmailDomains

isSuspended

boolean

cursor

string

limit

integer

expand

array<string>

Responses

Organization found. Response contains user search results

application/json

UsersSearchPage
POST/v1/orgs/{orgId}/users/search
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 }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "data": [ { "accountId": "<string>", "accountType": "atlassian", "accountStatus": "active" } ], "links": { "next": "<string>", "self": "<string>" } }

Rate this page: