Configure Plant API access claims in Smart API Manager - Intergraph Smart 3D Web API - Update 2 - Installation & Upgrade - Hexagon

To configure access claims in Smart API Manager, you use the Smart API Manager web application to authorize Smart Clients, add groups, add supported claim types, and add claims to groups.

For more help with the Smart API Manager application, see the Intergraph Smart API Manager help.

Open the Intergraph Smart API Manager web application

1. Navigate to the Intergraph Smart API Manager Dashboard Manager website.

2. Sign in using an administrator account.

Authorize the Smart Client

1. On the left panel, click Smart Clients .

2. Add a new Smart Client entry for each client that accesses the API.

3. Make a note of the Client ID and secret because you need them later when fetching a token.

Add groups

1. On the left panel, click Groups .

2. Click the group in the grid to see its details.

3. Create and name the group.

4. Define the external identities and users that are part of the group.

Get the resource identifier for the Smart API

1. On the left panel, click Smart APIs .

2. Click the Smart API in the grid to see its details.

3. Select the entry that was created when you configured the Plant Web Server in the configuration tool. This entry has:

   • A product value of S3D

   • A URL that matches the website you chose in the Configuration Utility's Plant Web Server page, in the Site Information section

4. Make a note of the resource identifier for the API. You will need this in the future to fetch a token.

Add supported claim types

The Configuration Utility automatically adds supported claim types for an API to Smart API Manager. Here, you can check that they were added correctly.

1. On the left panel, click Smart APIs .

2. Click the Smart API in the grid to see its details.

3. In the Supported Claim Types area, verify that the Access claim type appears and has the following values. If not, correct it.

   Value	Setting
   Name	Access
   User Name	Plant Access
   Type	String
   Values	leave blank
   Required	Checked
   Unique	Checked

Add claims to group

1. On the left panel, click Smart APIs .

2. Click the Smart API in the grid to see its details.

3. In the Authorized Groups section, click Add Group.

4. Add a Plant Access claim for each plant in the Smart 3D site to which the group needs at least READ access. Make sure to:

   • Prefix the site name to the plant name using the syntax SiteName:PlantName.

     To give access to multiple plants, use an asterisk ( * ) as a wildcard. For example, to give access to all plants give a plant name of *.

   • Repeat these steps for any existing groups that access one or more plants in the Smart 3D Site.

What's next?

Pick your path:

• If Smart API Manager is also the authorization provider for the Admin API - Continue with Smart API Manager to configure the access claims for the Admin API.

• Otherwise - Use you third-party authorization provider to configure the access claims for the Admin API.