Cloud

User management REST API / Reference / REST API

Lifecycle

Lifecycle APIs

Operations

POST/users/{account_id}/manage/lifecycle/disable POST/users/{account_id}/manage/lifecycle/enable POST/users/{account_id}/manage/lifecycle/delete POST/users/{account_id}/manage/lifecycle/cancel-delete

POST

Deactivate a user

Deactivate the specified user account. The permission to make use of this resource is exposed by the lifecycle.enablement privilege. You can optionally set a message associated with the block. If none is supplied, a default message will be used.

Request

Path parameters

account_id

AccountId

Required

Request bodyapplication/json

An object containing a message

message

string

Responses

Everything went fine, nothing to return.

POST/users/{account_id}/manage/lifecycle/disable

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/users/{account_id}/manage/lifecycle/disable' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "message": "On 6-month suspension"
}'

POST

Activate a user

Activates the specified user account. The permission to make use of this resource is exposed by the lifecycle.enablement privilege.

User accounts that were deactivated due to US export controls cannot be reactivated using this API. If you believe the account was incorrectly blocked, please contact Atlassian Support.

User accounts that have been deleted need the deletion to be canceled before reactivating.

Request

Path parameters

account_id

AccountId

Required

Responses

Everything went fine, nothing to return.

POST/users/{account_id}/manage/lifecycle/enable

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.atlassian.com/users/{account_id}/manage/lifecycle/enable' \
  --header 'Authorization: Bearer <access_token>'

POST

Delete account

This API will:

Delete a managed account from Atlassian Administration.
Withdraw complete access to all products and services listed in Atlassian Administration.
Remove reference to the account from all lists under Directory in Atlassian Administration.

Specifications:

Deleting an account is permanent. If you think you’ll need the account again, we recommend you deactivate it instead.
Before you permanently delete the account, you’ll have a 14-day grace period, during which the account will appear as temporarily deactivated.

Learn more about deleting a managed account.

Learn the fastest way to get the paramaters and delete account with a detailed tutorial.

The permission to make use of this resource is exposed by the lifecycle.delete privilege. Learn more about Get user management permissions API to manage the specified user.

Request

Path parameters

account_id

AccountId

Required

Responses

Success

application/json

ResultMessage

POST/users/{account_id}/manage/lifecycle/delete

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/users/{account_id}/manage/lifecycle/delete' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

POST

Cancel delete account

This API will:

Cancel the scheduled deletion of the specified managed account.
Restore and activate the user’s account.

Specifications:

You can cancel the deletion within the 14-day grace period of deleting a managed account. After that the account is permanently deleted.

The permission to make use of this resource is exposed by the lifecycle.delete privilege. Learn more about Get user management permissions API to manage the specified user.

Request

Path parameters

account_id

AccountId

Required

Responses

Success

application/json

ResultMessage

POST/users/{account_id}/manage/lifecycle/cancel-delete

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/users/{account_id}/manage/lifecycle/cancel-delete' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'