Manage
Profile
Email
Api Tokens
Lifecycle

Rate this page:

Lifecycle

Lifecycle APIs

Deactivate a user

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

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 Required

string

The ID of the user

Pattern: [a-zA-Z0-9_|:-]{1,128}
Body parameters
message

string

Example

1
2
3
4
5
6
7
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"
}'

Responses

Everything went fine, nothing to return.

Activate a user

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

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

Request

Path parameters
account_id Required

string

The unique identifier of the user to activate.

Pattern: [a-zA-Z0-9_|:-]{1,128}

Example

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

Responses

Everything went fine, nothing to return.

Delete account

Experimental

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

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:

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 Required

string

Unique ID of the user's account that you are deleting. Use the Get users in an organization API to get the accountId.

Pattern: [a-zA-Z0-9_|:-]{1,128}

Example

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

Responses

Success

Content typeValue
application/json

ResultMessage

Example response (application/json)

1
2
3
{
  "message": "Success"
}

Cancel delete account

Experimental

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

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 Required

string

Unique ID of the user's account that you are deleting. Use the Get users in an organization API to get the accountId.

Pattern: [a-zA-Z0-9_|:-]{1,128}

Example

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

Responses

Success

Content typeValue
application/json

ResultMessage

Example response (application/json)

1
2
3
{
  "message": "Success"
}

Rate this page: