Authentication
Obtain API keys and credentials to get started with Orum’s APIs.
Overview
Orum’s Authentication API requires users to create and manage an API Key and API Credentials to generate an auth token. Users can create and manage API Keys and API Credentials within the Orum Portal. See below for steps to obtain API Keys and API Credentials to generate your Auth token.
API Key
The API key is sent within the header of every Orum API call. This key can generated within the Orum Portal within the “API Authentication” tab — as seen below, under the “API Keys” header:
API Keys in The Orum Portal
API Credentials
API Credentials are specified within the body of the Orum Auth API call. These credentials can now be created and rotated within the “API Credentials” header of the “API Authentication” tab. See the screenshots below for the full flow:
Naming your API credentials
Generating new API credentials
Note:
- These credentials are NOT connected to your portal login and password. They are created and to be managed separately.
- These credentials are NOT needed for any other API call — they are only used to generate an auth token.
Updated 2 months ago