Generate API Key

Overview

You need an API key to use CloudCenter Suite APIs. Suite administrators or tenant administrator (for their respective tenants) can generate/regenerate an API key by using the Suite Admin UI or the user_api_key API call. 

UI Process to Generate Your Own API Key

To generate the API key from the UI for yourself, follow this procedure:

  1. Navigate to the Suite Admin Dashboard and click your account profile dropdown.

  2. Click the Generate API Key link to generate a new API key.

  3. Click Yes to replace the API key. You can now use this key to make REST API calls as listed in the Usage Example in the following screenshot.

UI Process to Generate API Key for Another User

To generate the API key from the UI for another user, follow this procedure:

  1. Navigate to the Suite Admin Dashboard > Users.

  2. Search for the required user and select Generate API Key from the Actions dropdown for this user as displayed in the following screenshot.

  3. Click the Generate API Key link to generate a new API key. This user can now make REST API calls using new API key.

API Process to Generate a New API Key

To generate the API key using the Suite Admin API call, follow this procedure:

  1. Issue the Password Service API Calls > /api/v1/users/{userId}/user_api_key API POST call to generate/regenerate the API key for yourself or for any other user.

    POST https://host-port/suite-password/api/v1/users/1/user_api_key
  2. Retrieve the apiKey from the response for this API.

    {
       "userId":1,
       "apiKey":"1.......-d538-4307-be79-e..........6",
       "accountNumber":"32768"
    }
  3. Use this apiKey to make REST API calls.


  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved