Orgs
Users
Domains
Events
Policies
Directory

Rate this page:

Directory

Org Directory APIs

Get user’s last active date

Experimental

GET /admin/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates

This API will return the last active date of a user for each product listed in Atlassian Administration. Active is defined as viewing a product's page for a minimum of 2 seconds. Last activity data can be delayed up to 4 hours.

Request

Path parameters
orgId Required

string

Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.

accountId Required

string

Unique ID of the user's account. Use the Jira User Search API to get the accountId (if Jira is available for your Organization). Jira APIs use a different authentication method .

Example

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'

Responses

Successful operation

Content typeValue
application/json

UserProductAccess

Remove user access

DELETE /admin/v1/orgs/{orgId}/directory/users/{accountId}

Removes all access the user has to products managed by the organization.

The API authentication header supports Organization API Keys. API keys allow you to manage your organization. Copy the values for your Organization ID and API key and call the API. API Key is used as an Authentication header Bearer token to call the API.

The API is available for customers using the new user management experience only. Learn more about the new user management experience.

Request

Path parameters
orgId Required

string

Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.

accountId Required

string

Unique ID of the user's account that you are deleting. Use the Jira User Search API to get the accountId (if Jira is available for your Organization). Jira APIs use a different authentication method .

Example

1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/directory/users/{accountId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

User access removed from organization. Everything went fine, nothing to return.

Suspend user access

POST /admin/v1/orgs/{orgId}/directory/users/{accountId}/suspend-access

Suspends user's access in your organization. Suspended users cannot access your organization’s products.

The API is available for customers using the new user management experience only. Learn more about the new user management experience.

Request

Path parameters
orgId Required

string

Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.

accountId Required

string

Unique ID of the user's account that you are suspending. Use the Jira User Search API to get the accountId (if Jira is available for your Organization). Jira APIs use a different authentication method .

Example

1
2
3
4
curl --request POST \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/directory/users/{accountId}/suspend-access' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

User was successfully suspended in the organization directory.

Content typeValue
application/json

GenericActionSuccessModel

Restore user access

POST /admin/v1/orgs/{orgId}/directory/users/{accountId}/restore-access

Restore user's access in your organization.

The API is available for customers using the new user management experience only. Learn more about the new user management experience.

Request

Path parameters
orgId Required

string

Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.

accountId Required

string

Unique ID of the user's account that you are restoring. Use the Jira User Search API to get the accountId (if Jira is available for your Organization). Jira APIs use a different authentication method .

Example

1
2
3
4
curl --request POST \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/directory/users/{accountId}/restore-access' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

User's access is successfully restored in the organization directory.

Content typeValue
application/json

GenericActionSuccessModel

Rate this page: