To integrate other services or applications with your Federated Directory you will need an API key. This is an OAuth 2 key with administrative permissions for your entire Federated Directory. It has the same permissions as an administrator, except the ability to log in to our portal. So make sure you submit these keys only at locations you trust and remove the keys you don't use.

When you want to integrate a directory for automatic user management (like with Azure AD or Okta) you will need a "Directory Key". You can create such a key within the directory itself. This key only has administrative permissions for the directory it was created.

Creating a new API key is as easy as pressing the orange button on the bottom right:

Add a new directory button

Enter a name and a description and you will receive a new key, consisting of:

Key attribute Description
issuer Unique identifier of the key.
private key To sign the JWT token to request a new access token. Keep it secure!
access token This is only shown to you once, directly after the creation of the key. It can be used directly as a bearer token and stays valid until the key is deleted.

Find out how to use such an integration key at the developer section.

Still need help? Get in touch!
Last updated on 11th Oct 2019