User API Keys for Services
In addition to end users, there are “users”
for services and other unmanaged, non-interactive processes. These
could include processes that listen for events or a customization
that communicates with one of our services. These are bestowed an
API key using Solution Center.
- In Solution Center, click the User Management plugin.
- Click the API Keys tab, then click Add New.
- Type a meaningful name that adequately describes the service. This can be changed later.
- Choose appropriate roles for the service. This is determined
by what the service needs to do, and thus, what level of permission
it must have.
-
Edge Service requires:
-
Designer.Admin
-
Monitoring.Reporting
-
Editor.Admin (This role is needed for the Edge API Key to create an Editor XI Session when using the Utility Network)
-
-
Storage Service requires:
-
Designer.StorageService
-
-
- On the Edit Role dialog, click Apply.
- After verifying the name and roles, click Save.
- Upon save, the application displays the Client ID and the
Client Secret. Use the Copy tools to copy these and save them in another,
secure location. This is particularly important for the Client Secret,
as it is only shown once. In other words, when you close Solution
Center and re-open, it is not displayed again.
- The Client ID and Client Secret normally go into a service
configuration file or are used for a customization to communicate
with a service.
TIP: Even after generating the Client ID and Client Secret, you can still change the roles as needed in Solution Center.