Create an API Client element

External applications use API clients to connect to SMC.

Before you begin

SMC API must be enabled for the Management Server.

For more details about the product and how to configure features, click Help or press F1.

Steps

  1. Select Configuration, then browse to Administration.
  2. Browse to Access Rights.
  3. Right-click Access Rights and select New > API Client.
  4. In the Name field, enter a unique name for the API Client.
  5. Use the initial authentication key or click Generate Authentication Key to generate a new one.
    Important: This key appears only once, so be sure to record it. The API Client uses the authentication key to log on to SMC API.
  6. Click the Permissions tab.
  7. Select the permissions for actions in the SMC API.
  8. Click OK.

API Client Properties dialog box

Use this dialog box to change the properties of an API client.

Option Definition
General tab
Name The name of the element.
Comment An optional comment for your own reference.
Authentication Key The authentication key that the API client uses to log on to the SMC API.
Generate Authentication Key Click Generate Authentication Key to generate a new Authentication Key. A random 24-digit alphanumeric authentication key is automatically generated.
Option Definition
Permissions tab
Unrestricted Permissions (Superuser) When selected, the administrator can manage all elements and perform all actions without any restrictions.
Restricted Permissions When selected, the administrator has a limited set of rights that apply only to the elements granted to the administrator.
Role Shows the role or roles assigned to the selected Administrator: Operator, Editor, Owner, or Viewer.
Granted Elements Shows the elements that an administrator has been given permission to edit and install when their Administrator Role would otherwise prevent them from doing so.
Domains Double-click the cell to select the Domains in which the rights granted by the Administrator Role and the selected elements apply.
Add Role Adds a role or roles for the selected API client.
Remove Role Removes a role from the selected API client.