How do I get the directory ID for use in the Atlassian SCIM Users API?

Jared Praino September 12, 2019

I would like to use this API https://developer.atlassian.com/cloud/admin/user-provisioning/rest/#about BUT I am blocked because I don't know how to get the Directory ID.

 

P.S. It would be nice to add a SCIM tag to posts.

--


Here is some background/context:

I have a personal sandbox org and my user has site admin rights.

I am trying to makes calls following the guides here: https://developer.atlassian.com/cloud/admin/user-provisioning/rest/#about

I have access to an admin user account on a sandbox environment.  I am able to successfully authenticate myself, but now need help finding the directory ID in order to make successful calls.

One example endpoint I would like to hit is this:

var options = {

   method: 'GET',

   url: 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}?attributes={attributes}',

   headers: {

      'Authorization': 'Bearer ',

      'Accept': 'application/json'

   }

};

 

I also looked at the steps described here https://developer.atlassian.com/cloud/admin/user-provisioning/swagger.v3.json

Go to [admin.atlassian.com](https://admin.atlassian.com/) and click your organization.

2. Click **Directory**, then click **User provisioning**.

3. Click the **Directory** tab, then click the **Regenerate API key** button.

4. Click **Regenerate key**.

5. Copy the organization ID and the API key to a safe place. Once you close the API key information screen, we won't show you this information again.

6. Click **Done**."

 

After step 1, when logged into my environment, I am unable to find the "Directory" or "User provisioning" tabs.  Instead I directly land on user management:

atlassianpro.jpg

1 answer

1 accepted

0 votes
Answer accepted
Dario B
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
September 20, 2019

Hi @Jared Praino ,

As the first step of the quoted documentation says, in order to see the Directory tab you need to select an organization:

Go to https://admin.atlassian.com/ and click your organization.

admin.jpg

 

 

Now, it can be the case that you don't have any organization configured and that's why you are sent straight to the User Management of your instance instead. In this case, please review below links for more details on Organizations and how to setup one:

 

 

Let me know if this helps.

 

Cheers,
Dario

Ernest Micklei March 27, 2020

the question was not answered, where can the directoryId be found?

 

thx,

E

Like Michael Aglas likes this
Dario B
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
April 1, 2020

Hi @Ernest Micklei ,

 

Please notice that the previous question was correctly replied since it was explicitly asking for how to get to Directory > User Provisioning tabs in admin.atlassian.com:

After step 1, when logged into my environment, I am unable to find the "Directory" or "User provisioning" tabs.  Instead I directly land on user management.

 

Indeed, the Directory ID is the one you actually create from Directory > User Provisioning tab in admin.atlassian.com. See below screenshots for details:



Screen Shot 2020-04-01 at 12.15.21 PM.pngScreen Shot 2020-04-01 at 12.15.50 PM.png

 

 

Once the directory has been created. The Direcrory ID is still visible under Directory > User Provisioning tab in admin.atlassian.com:

after it's been created.png

Like # people like this
Ernest Micklei April 1, 2020

thank you

Like Dario B likes this
YY哥
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
October 18, 2023

The latest version has no this screen to show the directory id.

Edward Murrell October 25, 2023

I also have this problem, where the existing solution does not work. I do not understand why there is no API to retrieve the directory ID.

Like YY哥 likes this
David A
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
November 22, 2023

Hello,

Your could try following URL replacing OrgID with your Organization ID:

https://admin.atlassian.com/gateway/api/adminhub/external-directory/manage-directory?orgId=OrgID 


Best regards

Like # people like this

Suggest an answer

Log in or Sign up to answer