Authorizations - Canvas

IMPORTANT

Authorizations are only applicable to Canvas type integration flows.

Overview

Authorizations ensure security and control in accessing external systems and internal flows. They allow you to authenticate connections with APIs, databases, and other services, using methods such as OAuth 2.0 tokens or API Keys. This protects sensitive data during transfer, ensuring that only authorized connections are established, preventing unauthorized access and vulnerabilities.

To register and view your authorizations, access the Authorizations page:

1. Through the left side menu of the product; or
2. By clicking the specific card on the Home page.

Register a new authorization

To register a new authorization, click the New Authorization button.

In the Authorization Type field, you can choose between API Key and OAuth 2.

To learn the step-by-step registration process for each of the available authorizations, visit the following pages:

• API Key
• OAUTH 2 - Client Credentials
• OAUTH 2 - Authorization Code
• OAUTH 2 - Authorization Code with PKCE

IMPORTANT

You must register authorizations in the environments where the integration flow will be deployed. To execute an integration via test mode (Test Mode), you must register the authorization in the Staging environment.

View your authorizations

If no authorizations are registered, you will see a message informing that no authorization has been created.

If you have already registered authorizations, the page displays them in alphabetical order, 12 per page by default. To change the number of records per page, use the LIMIT selector below the list.

By default, authorizations are displayed as cards. To switch between the card view and the list view, click the icons to the right of the filters.

To search for a specific authorization, type the name or description entered during authorization registration in the search field and click Search.

In the Type field, you can restrict the view by selecting the registered authorization type: API Key or OAuth 2.

If you want to clear what was typed or return to the initial view of the authorization list, click Clear.

The list view contains the following columns:

• Type: registered authorization type. Can be API Key or OAuth 2.
• Name: authorization name.
• Description: authorization description.
• Environment: authorization environments. The environment where the authorization is configured is shown in green, and an environment that is not configured is shown in gray.
• Actions: actions to be performed on registered authorizations:
  • : edits the registered authorization. Its name, type and grant cannot be changed.
  • : deletes the registered authorization. To confirm, click Delete.

NOTE

You cannot delete an authorization linked to an integration flow.