Updating integration registrations

The API Integrations page manages registered integrations. The People with active grants column is the total number of users who have a valid token. The token grants the user the right to run the integration. The Active grants column is the total number of issued tokens that your integration received. When tokens are revoked or the grant expires, the number of grants decreases.

To update existing integration registrations

  1. From the Platform menu bar, click API > Integrations.
  2. To limit the search to a subset of integrations, click All Integrations and make a selection. This is where you can see any saved filters.
  3. Locate the integration you want to update using searches or filtering, if desired.
  4. Click the name of the integration you want to modify.

  5. On any of these tabs, make your changes, and then click Save:

    • Overview: You can only change details for your own integrations. Venafi and technology partner integration overview information is read-only.
    • Base access: You can only change scopes for your own integrations. Venafi and technology partner integration scopes are read-only.

      TIP  When you add scopes or restrictions, the token with the original grant is still valid until it expires or it is revoked. Your developer should revoke the original grant and request a new grant with the new scopes or restrictions.

    • User and team access: Locate the identity that represents a person, team, or machine. To remove access for a user or team, click the trash icon in their row. To add a user or team, use the User or team search box to find the account(s) then click the box to select the account. Click Add, then click Save. If your identity list is covering the Add button, click outside the drop-down list to return to the main view. For more information see Revoking user and integration grants.

WARNING!  Be careful about updating existing integrations. If you remove scopes or privileges and restrictions from a working integration, the application that relies on that integration may break. It's usually better to create a new integration with the scope, privileges, and restrictions needed, and use that going forward.

JSON updates from integration owners

Sometimes integration owners will need to update their integrations, and will provide you with JSON-formatted code to use for the update.

IMPORTANT  If you update the scopes and restrictions for an existing integration, the systems that rely on the integration may stop functioning because their grants may no longer match the changes provided. If you update the JSON for an API integration, your developer should revoke the original grant and request a new grant with the new scopes and restrictions.

To update an API integration using JSON

  1. From the Platform menu bar, click API > Integrations, then locate the API integration you want to update.

  2. Check the box next to the integration you want to update, then click Update.

  3. Paste the JSON into the text box.

  4. Check the box stating you understand the risks of updating an integration and want to continue.

  5. Click Update.