Create an AuthSession
To launch the authentication flow, create an AuthSession and pass the returned session’s authFlowUrl
to the client for your end-user to visit in their browser.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Body
Your Conductor publishable key, which we use to create the session’s authFlowUrl
.
The ID of the EndUser for whom to create the IntegrationConnection.
The number of minutes after which the AuthSession will expire. Must be at least 15 minutes and no more than 7 days. If not provided, defaults to 30 minutes.
The URL to which Conductor will redirect the end-user to return to your app after they complete the authentication flow. If not provided, their browser tab will close instead.
Response
The unique identifier for this AuthSession.
The type of object. This value is always "auth_session"
.
"auth_session"
The date and time when this AuthSession was created.
The ID of the EndUser for whom to create an IntegrationConnection.
The secret used in authFlowUrl
to securely access the authentication flow.
The URL of the authentication flow that you will pass to your client for your user to set up their IntegrationConnection.
The date and time when this AuthSession expires. By default, this value is 30 minutes from creation. You can extend this time by setting linkExpiryMins
when creating the AuthSession.
The URL to which Conductor will redirect your user to return to your app after they complete the authentication flow. If null
, their browser tab will close instead.