API Access Page

Click Administration > API Access to display the API Access page. This page enables you to manage OAuth2 clients for accessing Riverbed IQ's APIs from other applications in order to execute runbooks and obtain analysis outputs. All OAuth clients have write access to Riverbed IQ.

The API Access page provides these controls:

• Create OAuth Client — Display the Create OAuth Client dialog to define a new API client; type a name and a secret expiration interval. Riverbed IQ generates a client ID and a client secret for you. Once you close this dialog, the client secret will never be shown again. Copy the client secret now (note the Copy icon immediately after it) and move it to a secure place immediately.

• Name — The user-defined name of the OAuth client.

• Earliest Client Expiration — The most immediate expiry date for any secret associated with this OAuth client.

• Client ID — This ID is autogenerated by Riverbed IQ and assigned to this OAuth client. Click the Copy icon to copy this ID to the clipboard to be able to use it elsewhere.

• Number of Client Secrets — The count of secrets associated with this OAuth client.

• ... menu — Click on the "three dots" menu to access these additional commands for managing the OAuth client secrets:

  • Manage Client Secrets — Open the Manage Client Secrets dialog to list the existing secrets for this OAuth client. From here, you can add or delete secrets. To replace a secret, add a new one, so that two are active simultaneously until you revoke one of them. This enables you to replace a secret without incurring downtime.

  • Delete OAuth Client — Remove this OAuth client permanently. A deleted client cannot make API requests.