Smart APIs - Intergraph Smart API Manager - 5.0 - Help

Intergraph Smart API Manager Help

Language
English
Product
Intergraph Smart API Manager
Search by Category
Help
Smart API Manager Version
5.0

Smart APIs are RESTful web APIs developed by Hexagon. These APIs typically provide access to data associated with software applications like SmartPlant Foundation or Smart 3D.

How level of access to a Smart API is determined

Smart API Manager uses groups to manage and control user access to a Smart API.

  • If a specific user needs to call a Smart API, that user—or an external identity representing the user—must belong to a group that is authorized to access the Smart API.

  • The claim values for a group can provide more granular control, depending on the particular Smart API and the claims it provides. For example, a Smart API might provide a claim to control whether users in a group are allowed to write data using the API or have read-only access.

    Claims are provided by the Smart APIs, and you should consult the specific Smart API Help for assistance in setting appropriate claim values.

Smart API setup

There are two tasks to initially set up Smart APIs:

  1. Register a new Smart API

    Typically, Smart APIs are registered immediately after their installation using a configuration tool provided with the Smart API installation. However, if necessary, you can register the Smart API in Smart API Manager.

  2. Give a group access to a Smart API

Smart API administration

After a Smart API is registered, administration tasks help you meet the ongoing access and security needs of your company.

To Change

See These Administration Tasks

Which groups have access to a Smart API

Disable an authorized group for a Smart API

Enable an authorized group for a Smart API

Remove group access to a Smart API

Give a group access to a Smart API

The level of access a group has to a Smart API

Configure claims for a group

Whether a Smart API is accessible to any group

Disable a Smart API

Enable a Smart API

Remove a Smart API

Register a new Smart API

Claims defined for a Smart API

Remove a claim type from a Smart API

Add a new claim type to a Smart API

Change a claim type for a Smart API

Valid values for a Smart API enumerated claim

Remove a value from a Smart API enumerated claim type

Add a value to a Smart API enumerated claim type

Change a value for a Smart API enumerated claim type

The secret that a Smart API must provide in its configuration file (appsettings)

Change the secret for a Smart API

Location of the Smart API

Change the URL of a Smart API

The Smart API name or other information

Change the name of a Smart API

If you do not know which Smart API you need to modify, start with Find a Smart API.