Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
oauth

Retrieve the oauth uri the user should be directed to in order to start the oauth flow

get/oauth/org/{orgIdentifier}/app/{appName}/{appUserId}

Path parameters

orgIdentifierstring required

Org identifier (either id or slug)

appNamestring required

App name

appUserIdstring required

App user id

Query parameters

returnTo'INSTALL' | 'MANAGE' | 'SELF_SERVE' | 'AGENT' | 'AI_CHAT' required

Where to return the user

finchAppType'ALL' | 'AUTOMATED' | 'SANDBOX_FINCH' | 'SANDBOX_PROVIDER'

The type of Finch app being installed

tokenLevel'ORG' | 'USER'

For OAUTH apps, whether to create a shared org or per-user connection

Response

successful operation

uristring required

uri to use for oath

Example response

{
  "uri": "https://api.tryfinch.com/connect/sessions"
}