Auth Link

Overview

Auth Links allow you to deliver a secure URL to your end users that integrates them seamlessly, giving them a secure, in-browser experience without requiring you to embed the Stackone Integration Hub in your webapp.

How to generate a link

An Auth Link can be generated directly from the StackOne dashboard. Here's how:

1. Log in to the StackOne dashboard and select Accounts from the left menu.

2. Press the 🔗 Create Auth Link button on the right hand-side

   

3. Fill in the required fields into the Create Auth Link modal:

   • Origin owner ID - this should be the customer identifier you use in your own system(s) (most likely, a UUID or integer)

   • Origin owner name - this is the Customer Name in your own system(s)

   • (optional) Origin username - your customers' user (eg: an email address) that will connect or be responsible for the connection of the system

   • (optional) Category - If you have enabled integrations across multiple category - you can filter the list of connector displayed
     Make sure that the information you enter matches your system precisely. Then click on Create Link.

   • 

     
     

4. A unique Auth Link is then generated. Copy and send this to your customer.
   3.
   
   

📝Note: This link expires after 5 days.

Generating the link programmatically

You can programmatically generate such links and enable a more scalable way of sending links to your customer (and allow your customers to send/forward it to someone with the required permission on the system they intend to connect).

The link is structured as follow: https://app.stackone.com/embedded/integrations?token={{connectSessionToken}}. Given you can generate a token any time using the Create Connect Session Endpoint, you can just as easily generate a link you can forward.

ℹ️ make sure to specify an appropriate value in expires_in when creating the token in order to leave enough time for your customer to complete the connection process after receiving the link (eg. 5 days is 432000, 7 days is 605000)

What does the receiving user see?

When the user clicks on the Auth Link, they will see the StackOne Integrations Hub with a list of all integrations enabled on your project. The user can then select the provider they want to connect and will be prompted to fill out their authorization details.

Verifying the Connection

After the user has completed their authentication and connected successfully, Stackone will fire a account.created webhook event containing the Account ID (which you will need to successfully make a unified API request. The linked account will also be displayed in the accounts page and it will also be visible via the Accounts API endpoint.