nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Need to use REST API to remove Jira Cloud site users' access.

Michael Savedra

Hi!

I am trying to build a bulk user deprovision script for our Jira platform using the REST API and python.

The current manual process is for the Tech Support team to select 'Remove User' when on the user's profile in the admin Administrator settings (see below screenshot).

I have tried the API recommended here: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-user-delete - but it doesn't seem to get a response from the server.

I also tried: https://developer.atlassian.com/cloud/admin/user-management/rest/api-group-users/#api-users-account-id-manage-lifecycle-disable-post but this may be depricated as I receive an auth issue.

Any ideas on the best API to use for removing site access in this way specifically?

Being able to remove users from the groups they are in would also be useful but the option here doesn'ty return any response from the cloud/server either: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-group-user-delete

I'm using Python so any advice in that langauge would be prefferred

Many thanks in advance!

Mike

Screenshot 2022-04-15 at 17.07.48.png

Accepted answers

All comments

Fabio Racobaldo _Catworkx_

Hi @Michael Savedra ,

based on the Atlassian Access Rest API doc, it seems that you are able to deactivate user through the following api https://developer.atlassian.com/cloud/admin/user-management/rest/api-group-users/#api-users-account-id-manage-lifecycle-disable-post

Could you try it?

Hope this helps,

Fabio

Michael Savedra

Hi @Fabio Racobaldo _Catworkx_ ,

Thanks for getting back.

This was the example that was giving me an authentication error. I thought this method may be depricated as the auth section is not in the same format as the usual REST API calls that specify "auth:" and require the JIRA account email and API token.

This only asks for the following: " headers = { "Content-Type": "application/json", "Authorization": "Bearer <access_token>" }"

Could you please specify how the auth details shoudl be formatted in this example?

Many thanks,

Michael

Fabio Racobaldo _Catworkx_

You need an API token first to use that API. Please take a look here https://support.atlassian.com/organization-administration/docs/manage-an-organization-with-the-admin-apis/

Michael Savedra

Hi @Fabio Racobaldo _Catworkx_ ,

So I have an API token already and this works for all other API calls.

For example when I need to return the accountID for a user I will use the following:

'''url = "https://{my-domain}.atlassian.net/rest/api/latest/user/search?query=" + str(user)

auth = HTTPBasicAuth("{email@mydomain.com}", "{my api token}")

headers = {

"Accept": "application/json"}

response = requests.request(

"GET",

url,

headers=headers,

auth=auth)

global account_Id

print((json.loads(response.text)[0]["accountId"]))

account_Id = (json.loads(response.text)[0]["accountId"])'''

However, when I try the following to disable the account:

'''url = "https://api.atlassian.com/users/" + account_Id + "/manage/lifecycle/disable"

headers = {

"Content-Type": "application/json",

"Authorization": "Bearer {my api token}"

}

payload = json.dumps( {

"message": "On 6-month suspension"

} )

response = requests.request(

"POST",

url,

data=payload,

headers=headers)

print(response.text)'''

This gives me a 401 authorization issue.

Notice the difference with the call that works with my api token, it requires the email address linked to this token where as the call for disabling the account seems to only require the api token? does "Bearer" need to be replaced with the admin account email? I tried this but it didn't seem to make any difference.

Many thanks,

Michael

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

cloud

jira-cloud