Generate API keys

Use API keys for APIs and data extraction. API keys authenticate your client application with Cisco GMM and includes an access key ID and a secret access key in place of a username and password. API keys are used by partners who do not have access to the Cisco GMM Cloud Application.

For example, use API Keys to:

• Securely authenticate API calls from external systems
• Connect to the GMM cloud over AMQP to receive data from devices and send commands to the data pipeline

API keys are displayed only once, when generated. The key cannot be edited or viewed later. Copy and save the token to a secure location.If you need to change the permissions, delete the key and generate a new one.

API keys are generated for a specific organization, and can't be used to access multiple organizations.

Summary steps

1. Log in to the Cisco GMM Cloud Application.
2. Generate an API key for the required organization, user role or management tasks.
3. Copy the API key.
4. Store the API key in a secure location.
5. Use the key in APIs or over AMQP to manage an organization's devices and data.

Detailed steps

API keys are displayed only once, when you generate them using the following steps. Copy and save this key to a secure location. The key cannot be edited or viewed later.

1. Log in to the Cisco GMM Cloud Application.
2. Select Tools > API Keys.
3. Click API Keys for Current User.
4. Click Generate API Key.
5. Enter a name for the API Key. For example, "Key for GW management".
6. Select an organization.
   • The API key will be valid for the devices and data managed by that organization only.
   • Service Providers can generate a key only for Organization Management.
7. For "Type of Role & Permission", select:
   • By User Role — The key will include only the functions permitted by the selected role, such as Admin or Operator.
     or
     
   • By Pre-defined Role & Permission — The key will include only the permissions for the selected Management types. These are the functions that can be accessed using the API key. For example:
     • Gateway Management—APIs used to claim gateways, get gateway status, and other gateway management functions
     • Data Management—APIs for data flow, such as data policies and related functions
     • App Management—Add apps, get app status, and related functions
     • Organization Management—Create organizations, add users that can access GMM. Service Providers only have access to organization management
       
       
       Also select the access level:
       
     • Read - Write—Provides access to Command Exchange used to send commands
     • Read Only—Provides the ability to subscribe to observations
8. Click Generate to create a key. The key is displayed once and cannot be displayed or edited after the window is closed.
9. Click Copy to copy the API key to your clipboard.
10. Paste the key into a file or other document and store it in a secure location. This token can be used to access the organizations data.
11. Use the API key in the API calls from your external system.

View or delete API keys

Select Tools > API Keys to display the existing API key names and other details. The actual key (token) cannot be displayed.

Admins can view a list of API keys for their organization by clicking the API Keys for Current Org tab.

To delete an API key, select the box next to the name and click Delete. Deleted keys are invalid and return an error if used.