Getting started

The contact data within a Federated Directory of a company is very valuable. The data gets even more powerful when it is accessible at the right moment. Within the applications and services this company is already using.

We made it as easy as possible to get started with our (SCIM compliant) API's and integrate it into your application.

Getting started in three steps:

  1. Sign-up for a free trial
  2. Setup your environment
  3. Import our Postman demo collection
  4. Send some requests

Sign Up for a free trial

You’ll need a Federated Directory to get started. If you don’t have one already, sign up to create one. (free 30 day trial, no credit card needed)

Setup your environment

  1. Create an Access token within your company. During this introduction we will the access token of a directory key. A directory key only has administrative entitlements on the directory it was created in.

  2. Install the Postman app

  3. Launch Postman and click the Import button. Select Import From Link, and paste this link into the textbox:

    • https://help.federated.directory/files/api.federated.directory.postman_environment.json

      Import the Federated Directory Getting Started Environment
  4. Once it’s imported, make sure the example.federated.directory environment is selected.

    Import the Federated Directory Example Environment

  5. Click the eye icon next to api.federated.directory and select Edit to replace the following values:


Value Description
accessToken Enter the access token you created earlier. This will be used in all API calls within the Postman demo collection.
directoryId The unique ID of the directory your users will be created in. You can find it under the 'config' tab on the same directory you created the directory key in step 1.

Click Update to save your changes.

Import our Postman demo collection

If you have Postman installed, clicking the link below gives you the option of importing the collection into Postman.

Click here to import collection 📥

You can also import the collection by following the Web View link and downloading the collection as a JSON file. Import that file into Postman by clicking the Import button and browsing to your download location.

Send some requests

Within the Postman demo collection you will find example API calls for the scenario's below. Since we are using a directory key, all query's are limited to the directory the key was created in.

Perform the below queries in the correct order. Id's of the created users are used in the subsequent search, update and delete calls.

1. Create a new user

The body already contains a detailed JSON of an example user. You can of course always adjust this or create your own. In the response you will find the users Id that you just created. This Id is stored as an environment variable in the Postman 'tests' of this request. We will use this in the next request to retrieve, update and delete this user.

2. Bulk create new users

Create multiple users at the same time with a bulk request. The body already contains a detailed JSON of a valid bulk request to create 4 users. All these users will be created in the "Bulk" department in the "Getting Started" division. The id's of the returned users are stored as environment variables.

3. Search for users

Retrieve all the users in the "Bulk" department in the "Getting Started" division. Will only the return the requested attributes. Also check out the Users API documentation for more advanced query options.

4. Retrieve the profile data from user

Get the profile data from the user created in step 1. Only return the requested attributes. Requires a correct userId in the environment settings.

5a. Update a user (patch)

A patch call will only changed the mentioned attributes in the patch call. All other attributes will stay untouched. The response contains the complete user.

5b. Update a user (put)

A put call should contain all attributes of a user. Attributes not included in the body will be removed or reset. The response contains the complete user.

6. Delete a user

Delete the user created in step 1. No body in the response.

7. Bulk delete all created users

Remove all the users created in step 2.


These demo API calls should give you a good understanding of some the basic functions of our API's. More details can be found within our [Users API](/developer/users-api) documentation.
Still need help? Get in touch!
Last updated on 24th Mar 2019