Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When setting up a new integration on Canvas, the first step is to add register the applications we want to connect.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

On Canvas handles API authentication for you, you can safely store simplifying the process while ensuring safe handling of sensitive data.

When you register a new application on a user account you will be asked to provide the API credentials (usernames, passwords, API keys, etc.) by registering applications. This simplifies authentication and ensures safe handling of sensitive datawhich will be used by the integration.

These details are then stored safely in the user account.

To add an application to the user account, go to the Applications section and click the + sign in the top right corner:

...

Select the application you want to connect , enter to.

Enter the requested credentials, and give the application a descriptive name, and press Authenticate.

...

Note

Make sure to give the app a name

The credentials are now stored safely in an encrypted vault, and session tokens are automatically refreshed. This allows lets you to build integrations and interact with the API without worrying having to think about API authentication.

Repeat this process to register applications for all other apps that will be part of your integration.

...