Cloud

User provisioning REST API / Reference / REST API

Admin APIs

These sets of APIs will require the organization API token rather than the SCIM directory token.

Operations

DEL/admin/user-provisioning/v1/org/{orgId}/user/{AAID}/onlyDeleteUserInDB GET/admin/user-provisioning/v1/org/{orgId}/user/{aaId}/get-scim-links POST/admin/user-provisioning/v1/org/{orgId}/get-scim-links-for-email PATCH/admin/user-provisioning/v1/org/{orgId}/scimDirectoryId/{scimDirectoryId}/scimUserId/{scimUserId}/unlink

DEL

Delete user in SCIM DB

Delete a user in our SCIM DB with a Atlassian Account ID (AAID). This will apply to all directories in your organization matching that AAID and only works for managed users.

You will have to completely reprovision the user to their respective groups after deletion.

Explore more about updating managed SCIM email addresses.

Request

Path parameters

orgId

string

Required

AAID

string

Required

Responses

Users deleted via AAID.

DEL/admin/user-provisioning/v1/org/{orgId}/user/{AAID}/onlyDeleteUserInDB

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/admin/user-provisioning/v1/org/{orgId}/user/{AAID}/onlyDeleteUserInDB' \
  --header 'Authorization: Bearer <access_token>'

GET

Get SCIM links for an accountPreview

Get SCIM Links for a Atlassian Account ID (AAID).

Request

Path parameters

orgId

string

Required

aaId

string

Required

Responses

Scim Links for an Atlassian account in an org.

application/json application/scim+json

Get SCIM Links for Atlassian Account ID Response

Response containing SCIM links for an Atlassian account ID

GET/admin/user-provisioning/v1/org/{orgId}/user/{aaId}/get-scim-links

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/user-provisioning/v1/org/{orgId}/user/{aaId}/get-scim-links' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

200Response

{
  "scimLinks": [
    {
      "scimUserId": "<string>",
      "atlassianAccountId": "<string>",
      "orgId": "<string>",
      "directoryId": "<string>"
    }
  ]
}

POST

Get SCIM Links for an emailPreview

Get SCIM Links for an email address in an organization.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json application/scim+json

Provide the email address to search for SCIM links.

email

string

Required

Responses

SCIM links for an email in an org.

application/json application/scim+json

Get SCIM Links for email response

Response containing SCIM user links for an email address.

POST/admin/user-provisioning/v1/org/{orgId}/get-scim-links-for-email

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/user-provisioning/v1/org/{orgId}/get-scim-links-for-email' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>"
}'

200Response

{
  "scimLinks": [
    {
      "scimUserId": "<string>",
      "atlassianAccountId": "<string>",
      "orgId": "<string>",
      "directoryId": "<string>"
    }
  ]
}

PATCH

Unlink a SCIM user from their Atlassian accountPreview

Unlinks a SCIM user from their Atlassian account without deleting the user.

Request

Path parameters

orgId

string

Required

scimDirectoryId

string

Required

scimUserId

string

Required

Responses

User successfully unlinked.

PATCH/admin/user-provisioning/v1/org/{orgId}/scimDirectoryId/{scimDirectoryId}/scimUserId/{scimUserId}/unlink

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PATCH \
  --url 'https://api.atlassian.com/admin/user-provisioning/v1/org/{orgId}/scimDirectoryId/{scimDirectoryId}/scimUserId/{scimUserId}/unlink' \
  --header 'Authorization: Bearer <access_token>'