Sign in
Connected Accounts

Create a new auth link session

Creates a new authentication link session that users can use to connect their accounts

post/api/v3.1/connected_accounts/link

Request body

auth_config_idstring authConfigId required

The auth config id to create a link for

user_idstring required

The user id to create a link for

aliasstring

A human-readable alias for this connected account. Must be unique per entity and toolkit within the project.

callback_urlstring

The callback url to create a link for

Response

Successfully created auth link

link_tokenstring required

The generated link token for the auth session

redirect_urlstring required

The redirect URI to send users to for authentication

expires_atstring required

ISO timestamp when the link expires

connected_account_idstring connectedAccountId required

The connected account ID that was created

Changes

Changed in 7 of the 61 revisions of this API.3210

  • ad121cf38fe011See the full diff
    • ▲

      removed subschema #72 subschema #73 from the request property anyOf list

      request-property-any-of-removed

    • ○

      added subschema #72 subschema #73 to the request property anyOf list

      request-property-any-of-added

  • ca2b1b8e13721See the full diff
    • ○

      the endpoint scheme security CookieAuth was removed from the API

      api-security-removed

  • 166dca8a495b122See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 23348819b35e12See the full diff
    • ▲

      removed subschema #9 subschema #10 from the request property anyOf list

      request-property-any-of-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added subschema #9 subschema #10 to the request property anyOf list

      request-property-any-of-added

  • 55e9c3b27c952See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 5a3709be76a71See the full diff
    • ○

      added subschema #13 to the request property anyOf list

      request-property-any-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 52c71f747c651See the full diff
    • ○

      endpoint added

      endpoint-added