Describes About Key Admin API Keys in Cisco Secure Access. The Secure Access Key Admin API enables you to create and manage Secure Access API keys programmatically.
The Secure Access Key Admin API enables you to create and manage Secure Access API keys programmatically. In a REST client, use your KeyAdmin API key credentials to authenticate with Secure Access and generate a short-lived API access token. Then, make Key Admin API requests with your access token to create Secure Access API keys for your organization. You must include your access token in every API request. For more information, see Secure Access API Authentication.
You can create any number of Key Admin API keys for your organization. When you create a Key Admin API key, choose a unique key name, description, permissions, and key expiry date. If you do not set an expiration date when you add the key, Secure Access sets your Key Admin API key to never expire.
Once you add a KeyAdmin API key to Secure Access, you can refresh your key's credentials, update the key's name, description, expiration date, and permissions, and delete the API key.
If your organization uses a multi-organization setup, ensure that you generate API keys from the specific organization where the key will be used. Using a parent organization API key to generate client credentials for a child organization can cause virtual appliances to sync with the parent organization, which may lead to DNS outages or the loss of internal domain synchronization for the child organization.
Use Cases
-
Programmatically create Secure Access API keys.
-
Programmatically manage the Secure Access API keys in your organization—refresh API key credentials, update API key properties, or delete API keys.
-
Use the Key Admin API to manage the organization's Secure Access API keys.
