Cloud Services

ModernOps

API keys revoke
Published On May 16, 2024 - 1:22 PM

API keys revoke

Discover the actions that portal users can perform through system integrations with other back-end systems that provide API keys.
API key revocation is permitted as follows:
  • Revoking an API key is available to end (portal) users for their respective keys.
  • Revoking an API key for system users is available only to authorized users.
  • Revoking any portal user API key is available to authorized users.
Using the functions in the User Access Management window, users can search for or sort by a user ID or type, and revoke API keys one at a time, a page at a time, a type at a time, or for all users.
When a user is deleted from the system, the corresponding API key is also deleted.
Select from the following options:

Search for or sort by a user ID or type

To search for a User ID or Type:
  1. On the User Access Management page, click
    API Key
    at the top of the page.
  2. Type the search parameters in the search box and click
    return
    or
    enter
    . A list of options displays.
To sort by a User ID or Type:
  1. On the User Access Management page, click
    API Key
    at the top of the page.
  2. Click the column heading to sort by the selected column (User ID or Type) in alternating ascending and descending order.

Revoke a single API key

To revoke a single API key:
  1. On the User Access Management page, click
    API Key
    at the top of the page and select the line item you want to address.
  2. Click the
    overflow menu
    on the right hand side of the row.
  3. Select
    Revoke API Key
    .
  4. At the Revoke API Key message, click
    OK
    to remove the API key, or click
    Cancel
    to close the window without revoking the key. A success message displays in the upper-right corner of the page.

Revoke multiple API keys

To revoke multiple API keys:
  1. On the User Access Management page, click
    API Key
    at the top of the page and click the checkbox beside all of the User IDs for which you will revoke an API key. The Revoke API Keys bar displays beneath the search bar. The bar includes the number of items selected.
  2. Click
    Revoke API Keys
    to revoke the API keys, or click
    Cancel
    on the right-hand side of the bar to cancel the operation. The Revoke API Keys window requires that you click
    OK
    to confirm your revocation or
    Cancel
    to cancel the operation. A success message displays in the upper-right corner of the page.

Revoke a single page of API keys

To revoke all of the API keys on a single page:
  1. On the User Access Management page, click
    API Key
    at the top of the page and click the checkbox beside
    User ID
    at the top-left of the list. All of the checkboxes on the page are checked. The Revoke API Keys bar displays beneath the search bar.
  2. Click
    Revoke API Keys
    to revoke the API keys, or click
    Cancel
    on the right-hand side of the bar to cancel the operation. The Revoke API Keys window requires that you click
    Ok
    to confirm your revocation or
    Cancel
    to cancel the operation. A success message displays in the upper-right corner of the page.

Filter to revoke type of API keys

To revoke all API keys of a particular type:
  1. On the User Access Management page, click
    API Key
    at the top of the page and, on the right side of the page beside Revoke All API Keys, click the API key filter icon.
  2. Click a checkbox to select a Type from the dropdown list.
  3. Click
    Revoke All [type] API Keys
    . Note that [type] can be System or User, whichever is selected. The Revoke [type] API Keys window requires that you click
    Ok
    to confirm your revocation or
    Cancel
    to cancel the operation. A success message displays in the upper-right corner of the page.

Revoke API keys for all users

To revoke the API keys for all users:
  1. On the User Access Management page, click
    API Key
    at the top of the page and, on the right side of the page, click
    Revoke All API Keys
    . The Revoke [type] API Keys window requires that you click
    Ok
    to confirm your revocation or
    Cancel
    to cancel the operation. A success message displays in the upper-right corner of the page.
All API keys are revoked using this function, including the System Administrators.

Error scenarios

If for any reason an API key cannot be revoked, a message displays the notification "
Unable to Revoke API Key
." Click
Okay
to close the window.
Do you have two minutes for a quick survey?
Take Survey