Configure API Services to use Intergraph Smart API Manager (SAM) - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

This functionality was modified in an update. For more information, see Configure API Services to use Intergraph Smart API Manager (modified in update 23).

From Update 23, Smart API Manager (SAM) is the default authorization server provided with HxGN SDx. If your application server was created with an authorization server other than SAM before Update 23, you must configure the application server to use SAM authorization by editing the application server web.config file and the Web Client settings.js file. For more information, see Configure the HxGN SDx application site and Edit the Web Client configuration.

From Update 29, SmartPlant Foundation Server Manager configures SmartPlant Foundation and HxGN SDx Server Manager configures SDx for you through the Site and Web Client Site creation wizards.

From Update 50, the Web Client settings.js file has been renamed as Web Client settings.json file.

A Smart API Manager (SAM) authorization server provides token-based resource protection that implements the OAuth authorization protocol. You use an SAM authorization server to register clients as Smart Clients, as your application must be authorized to access the SAM authorization server to consume any web APIs.

You configure a system for SAM authorization in two stages:

  1. The creation of items within SAM to support the generation of OAuth tokens for the application. This includes the creation of an identity provider, a user group, a new Smart Client, and a Smart API.

  2. Server Manager configures the application server web.config file and the Web Client settings.json file through the Site and Web Client Site creation wizards.

If your system employs users configured using an external identity provider, such as Active Directory, the users must be created in HxGN SDx before they can log in.