API key generation and management - HxGN EAM - 12.1 - Feature Briefs - Hexagon

HxGN EAM Integration Configuration

Search by Category
Feature Briefs
HxGN EAM Version

The Integration Configuration screen also supports the ability to generate and manage API keys to be used as an authentication method for inbound web service calls. API Keys are generated for a specific user against a defined application name. This allows generation and/or revocation of API Keys for the same user across various application integrations, while providing the ability to revoke the API keys for one application without disrupting other integrations leveraging the same user. API Key authorization for a user will work agnostic of the calling application name if the API Key is not expired and/or revoked.

After selecting a User ID, click the Generate API Key button. This will display the API Key in a warning prompt with the following message: "Record this API Key now. It will not be available to view later."

Clicking the Generate API Key button when API Key 1 exists will move API Key 1’s current values into their respective API Key 2 values; and replace API Key 1’s values with the newly created API Key information.

The install parameter APIKEXPD is used to calculate the API Key Expiration (date). If this parameter is null or contains an invalid value, the API Key 1 Expiration field will display with no populated value.

The install parameter APIROTD is used to determine the rotation days to be applied to the API Key 2 Expiration (date). This rotation day methodology creates a grace period during which the user can revise API Key values to ensure a smooth transition when a new API Key is generated and employed top make API calls. If this parameter is null or contains an invalid value, the API Key 2 Expiration field will be set to the value of API Key 1 Expiration.

Updating these install parameters after API Keys have been generated will update all API Key expiration dates to the updated expiration date based on the new value.

The application name EAMA – EAM API is the default inbound EAM application. This application represents the EAM tenant in which you are currently logged into and is agnostic of application integrations.