A directory contains the users of your company and their contact data.
There are 2 types of directories:
The default directory. Whenever we mention a 'directory', this is the one we mean.
Ideally meant for non-personal contact data, like service desk telephone numbers or the email address of your HR department
A quick comparison between the two:
|Capability||User directory||Contact list|
|Contact data in this directory is searchable for the users in your company||✔️||✔️ ️️|
|Contains users that can login and search contact data||✔️|
|Can be created (multiple) and removed||✔️|
|Can be federated to other companies||✔️|
|Can be integrated with other services (with Azure AD or G Suite for example)||✔️|
|License model||per user per month||free, up to 1000 contacts|
When you sign up for Federated Directory, we create a "User directory" and a "Contact list". The administrator account you receive during sign up is located in the "User Directory". This help section describes the creation and configuration of "User directories", hereafter called "directories".
Before we explain how to create and configure a directory, we first want to focus on the concept of creating multiple directories within your company.
When the users in your company work or exist in different cloud services (like G Suite and Office 365) This could happen after mergers for example, but it could also be a deliberate choice of your IT department. Combine those user groups in your Federate Directory by creating a directory for every group and integrate that directory with the cloud service.
When the users of your company require different federation policies After you created a federation with another company, you can configure which data you want to share with that company. This is adjustable per directory. For example, if you want to share the contact data of a specific user group of your company. Put those users in a separate directory and only share the contents of this directory with other companies.
Login prompt will ask your users in which directory their account resides We have to know the user's directory user, because a username is unique in a directory and not in a company. But also, because you can configure a different authentication method for every directory. (more about this topic later) Multiple directories have no impact on your users search experience. They will search contact data in a company and will not see or notice the underlying directories.
Create or configure a directory
Creating a new directory is easy: go to 'Directories' and select the orange '+' plus button at the bottom right.
A dialog opens in which you can configure your new directory. It might be good to know that you can always change the below settings.
|Display name||Give your new directory a name. Max 100 characters.|
|Description||Contains users that can login and search contact data.|
Flip the switch if you want your users to be able to find the users in this directory when they search their Federated Directory.
Then the interesting stuff. A directory is defined by two settings:
- Authentication method
- How are the users in this directory going to login?
- Automatic user management
- How are the users and their contact data in this directory going to be managed (created, updated, deleted)?
Authentication MethodIt's important that your users can login as easy and secure as possible to their Federated Directory. They need to save time and spend the minimum amount of time authenticating. That's why we support a wide range of authentication methods.
Federated Directory accounts
Automatic User ManagementThe power of your Federated Directory depends on the accuracy and completeness of the contact data it contains. The best and easiest way to keep it up to date, is to create an integration with your current enterprise address book and automate the management (create, update, delete) of user data in your directory. We support the methods described below.
G Suite Directory
Select tab "logo" to change the logo of this directory. We use this logo whenever the directories of your company are displayed. For example, during the login process, when there are multiple directories to login to.
Click the "select logo" button and select an image from your local machine.
The file you select must have:
- the JPG or PNG format
- a maximum file size of 3MB
- a resolution of 150 x 150 pixels (for best results)
You can resize and crop your image here.
When you have selected a logo it will appear on your screen and the "update logo" button lights up.
Press the update logo button and your new directory logo will be uploaded to our servers.
The best way to integrate another system with one directory, is to use a directory key. A directory key only has administrator privileges inside the directory it is created. With a directory key, the other system can create, read, update and delete the users inside that directory only.
All automatic user management solutions mentioned above require a directory key for their integration with Federated Directory.
Select tab "keys" to manage the directory keys inside a directory. Select the orange '+' plus button at the bottom right to create a new key.
After the key is created, you will receive an
private key and an
access token. The
access token can only be seen (and copied) after the creation of a new directory key. It gives direct access to all user data inside this directory, so store it safely.
private key can be used to create an access token, based upon the OAuth2 principle. Check out our developer help section for the details.
If you do not use a directory key, remove it by clicking on the three dots menu icon behind the key.
Delete a directory
Every directory can be easily removed. However remember that all users in this directory will also be removed from Federated Directory. Their user data will no longer be available; Not only for the users of your own company but also for any company you federated with.
You can delete a directory from the 'directory overview'.
- Go to "directories" in the side menu
- Select the 'menu button' on the directory you want to delete
- Select 'delete directory' from the drop-down menu