Manage the Cloud Administration REST API Keys

Document created by RSA Information Design and Development on Jul 20, 2018Last modified by RSA Information Design and Development on Oct 19, 2018
Version 8Show Document
  • View in full screen mode

Clients calling the Administration Event Log, User Event Log, and Help Desk APIs must authenticate themselves by including a JSON Web Token (JWT) in each request. The JWT is signed using an Administration API key. You can generate up to 10 keys using the Cloud Administration Console. The API keys do not expire. You must manually delete API keys from the Cloud Administration Console when they become compromised or are not in use. You can regenerate a key if it is lost or compromised.

Note:  Only a Super Admin for the Cloud Administration Console can generate or delete an API Key. The Super Admin provides the API Key File to the Endpoint Administrator.

For detailed information on the APIs, see:

For instructions on managing API keys, see:

Administration API Key File

An Administration API Key file contains the following sensitive data:

  • Access ID - A unique identifier for the API Key.
  • Access Key - A private key that you generate and download.

The following example displays the contents of an Administration API Key File.

{

"customerName":"mycompanyname",

"accessID":"139f6495-e447-4a26-a765-5c01b6b152d5",

"description":"Integration with NetWitness",

"accessKey":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAtyDNwTjD1DEQRs2BjXy0U9I+tTOIzVMeve6cELmOCQgdLYjI\ntpw12FFZY4gT1JX9Mp/uVYKuZGhhvSbB/KhUTzQ9GrondRNto4zz7zOw4Qhzs xFd

"adminRestApiUrl":"https://access.securid.com/AdminInterface/restapi"

}

Add an API Key

The Super Admin uses the Cloud Administration Console to generate the Administration API Key.

Procedure 

  1. In the Cloud Administration Console, click Platform > API Key Management and select the Administration API Key tab.
  2. Click ADD. The new key is displayed.
  3. (Optional) Enter a description that identifies how the key will be used.
  4. Click Save and Download to download and save an API Key File.

Note:  The API Key is saved on your server only after you click Save and Download. If you click Regenerate, you cannot use the previous API Key file.

After you finish 

Use a secure method to deliver the API Key File to the Endpoint Administrator.

Delete an API Key File

To delete an API Key File, perform these steps.

Procedure

  1. In the Cloud Administration Console, click Platform > API Key Management and select the Administration API Key tab.
  2. Select next to the API Key File that you want to delete.
  3. When prompted, click Delete.

Regenerate an API Key File

If an API Key File is lost or compromised, you can regenerate an API Key File.

Procedure

  1. In the Cloud Administration Console, click Platform > API Key Management and select the Administration API Key tab.
  2. Click Regenerate to generate and download an API Key File.

 

 

You are here
Table of Contents > Cloud Administration REST APIs > Manage the Cloud Administration REST API Keys

Attachments

    Outcomes