Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

How to Deactivate the user via API?

Mohamed Musheer
Contributor
March 30, 2021

Want to know Jira Align API for Deactivate the user 

Referd the below Doc but not able to find the API

https://<site-url>/rest/align/api/docs/index.html

1 answer

1 accepted

2 votes
Answer accepted
Rodrigo Cortez
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
March 30, 2021

Hi @Mohamed Musheer,

Nice question!

Assuming a few things...

a) You've read the following Help Center articles: 10X: API 2.0 

b) You've looked at the specific documentation (aka Swagger), that's available in your Jira Align instance: https://instance.jiraalign.com/rest/align/api/docs/index.html

c) You have a valid API 2.0 token, and corresponding grants to perform this operation in UI

 

To deactivate a user, by using Jira Align API 2.0, make the following call:

PATCH https://instance.jiraalign.com/rest/align/api/2/Users/<id>

Where <id> is the userId of your user.

As request body, use the following JSON:

[
{
"op": "replace",
"path": "/locked",
"value": -1
}
]

A successful deactivation call should return an HTTP 204 (Success) response code.

Keerthi January 29, 2024

getting error like "The target location specified by path segment 'locked' was not found."

Colin Weaver
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
August 13, 2024

@Keerthi - it appear the field is called isLocked however I am not sure if Locked was correct back in 2021 and has been changed to isLocked since

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events