API (Application Programming InterfaceClosed Application Programming Interface. A set of protocols and tools that allows different applications to communicate with each other, enabling runbook execution and data retrieval from external systems.) Access Page

The API Access page enables you to manage OAuth2Closed OAuth2. An authentication protocol that allows applications to access resources on behalf of users without sharing passwords, used for API access and third-party integrations. clients for accessing Riverbed IQ Ops APIs from other applications in order to execute runbooksClosed An automated workflow that executes a series of steps or tasks in response to a triggered event, such as the detection of anomalous behavior generating an incident, a lifecycle event, or a manually executed runbook. and obtain analysis outputs. An OAuth client identifies a single application. By default, OAuth clients have write access to Riverbed IQ Ops APIs.

You can also assign built-in Role-Based Access Control (RBACClosed Role-Based Access Control) roles directly to each OAuth client so that access tokens honor only the permissions those roles allow. For how OAuth client roles work, which roles you can assign, and how to obtain an access token, see OAuth Client Roles.

Navigate to the API Access Page:

  1. Click the Launchpad button ⁝⁝⁝.
  2. Click IQ Ops > Management.
  3. In the Management page, click the Hamburger Icon, then click API Access Page.

The top of the page lists values integrations use for access token requests: Access Token URI, API Scope, Base URI, and Tenant Id. Use the copy control next to each value when you configure an integration.

The API Access page provides these controls:

  • Create OAuth Client: Open the Create OAuth Client dialog to define a new API client. Type a name and a secret expiration interval. When OAuth client roles are enabled for your tenant, assign one or more roles in Assigned Role(s). Riverbed IQ Ops generates a client ID and a client secret for you. Once you close the OAuth Client Created dialog, the client secret is not shown again. Copy the client secret now (use the copy control next to it) and store it in a secure location immediately.

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

  • Roles: The built-in roles currently assigned to the OAuth client. This column appears when OAuth client roles are available on the page.

  • 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 Ops and assigned to this OAuth client. Click the copy control to copy this ID to the clipboard.

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

  • ... menu: Click the menu on a client row to access these commands:

    • 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 lets you rotate a secret without downtime.

    • Assign Role(s): Open the Edit Roles dialog to add or remove built-in roles on the OAuth client. This command appears when OAuth client roles are available on the page. For details, see OAuth Client Roles.

    • Delete OAuth Client: Remove this OAuth client permanently. A deleted client cannot make API requests or obtain access tokens.