Auth Session Creation API

post

https://api.getknit.dev/v1.0/auth.createSession

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

originOrgId

string

required

Your user's orgainsation id - this should be unique

originOrgName

string

required

Your user's organisation name

originUserEmail

string

required

Email of your user who is performing the integration.

originUserName

string

required

Name of your user who is performing the integration.

filters

array of objects

Filters are optional but will help you filter in categories and apps that are relevant for you and only the categories/apps mentioned in the filters array will be shown to your users in Knit UI component

filters

clearErrors

boolean

Defaults to false

testAccount

boolean

Defaults to false

Mark the integration done through this session as test account. If this is not provided, account default value will be used. See https://developers.getknit.dev/docs/integrated-accounts-settings for details.

showScopeControl

boolean

Defaults to false

Toggle the scope management panel visibility during the integration flow.

showCustomMapping

boolean

Defaults to true

Toggle the custom fields mapping panel visibility during the integration flow.

language

string

Defaults to en

Allowed values: en for English, fr for French, de for German

customMappingRequired

boolean

Defaults to false

If set to true, custom mapping of fields is mandatory and cannot be skipped.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400