COconductor-is

Create an auth session

Changed on

To launch the authentication flow, create an auth session and pass the returned session's authFlowUrl to the client for your end-user to visit in their browser. Demo: https://connect.conductor.is/qbd/demo

post/auth-sessions

Request

Request body

publishableKeystring required

Your Conductor publishable key, which we use to create the auth session's authFlowUrl.

endUserIdstring required

The ID of the end-user for whom to create the integration connection.

linkExpiryMinsnumber

The number of minutes after which the auth session will expire. Must be at least 15 minutes and no more than 7 days. If not provided, defaults to 30 minutes.

redirectUrlstring uri

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.

Example request

{
  "publishableKey": "{{YOUR_PUBLISHABLE_KEY}}",
  "endUserId": "end_usr_1234567abcdefg",
  "redirectUrl": "https://example.com/auth/conductor-callback"
}

Response

Returns the auth session object.

idstring required

The unique identifier for this auth session.

objectType'auth_session' required

The type of object. This value is always "auth_session".

createdAtstring required

The date and time when this auth session record was created.

endUserIdstring required

The ID of the end-user for whom to create an integration connection.

clientSecretstring required

The secret used in authFlowUrl to securely access the authentication flow.

authFlowUrlstring required

The URL of the authentication flow that you will pass to your client for your user to set up their integration connection.

expiresAtstring required

The date and time when this auth session expires. By default, this value is 30 minutes from creation. You can extend this time by setting linkExpiryMins when creating the auth session.

redirectUrlstring nullable required

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.

Example response

{
  "id": "auth_sess_1234567abcdefg",
  "objectType": "auth_session",
  "createdAt": "2024-01-01T12:34:56.789Z",
  "endUserId": "end_usr_1234567abcdefg",
  "clientSecret": "auth_sess_client_secret_1234567abcdefg",
  "authFlowUrl": "https://connect.conductor.is/qbd/auth_sess_client_secret_1234567abcdefg?key={{YOUR_PUBLISHABLE_KEY}}",
  "expiresAt": "2024-01-01T12:34:56.789Z",
  "redirectUrl": "https://myapp.com/auth/callback"
}

Changes

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property redirectUrl list-of-types was widened by adding types null to media type application/json of response 200

  • 8e0b7df2044dRevision changes
    • breaking

      the response property became nullable for the status

    • info

      response property redirectUrl list-of-types was narrowed by removing types null from media type application/json of response 200