Introduction

Changes in HelloID may be made via the Administrator Dashboard or the API. Documentation on the HelloID API can be found here. Before you can communicate with HelloID via API, however, you must create an API Key. Navigate to Security > API on the HelloID Administrator Dashboard to see an overview of all the API keys used within your organization's HelloID environment. Search through the API keys using the search bar or by scrolling through the list.

The following information is displayed for API keys:

1. API Key Code
   The unique key for this API.
2. Note
   The Note column allows admins to add a description when registering the API Key. This commonly includes the API’s purpose or which application(s) and/or developer(s) have used the API Key.
3. Status
   The status of an API key. Applications using disabled keys are not allowed to access the HelloID API.
4. Actions
   The links here give you the ability to edit or delete an API key.

Next: How to Create and Maintain API Keys