Unified API Reference
DashboardSignup For Free

Auth Session Creation API

post
https://api.getknit.dev/v1.0/auth.createSession
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Integrated Accounts are marked as Test by default.

You can change a Test Integrated Account to Production or vice versa. See how.

Body Params
string
required

Your user's orgainsation id - this should be unique

string
required

Your user's organisation name

string
required

Email of your user who is performing the integration.

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
boolean
Defaults to false
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.

boolean
Defaults to false

Toggle the scope management panel visibility during the integration flow.

boolean
Defaults to true

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

string
Defaults to en

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

boolean
Defaults to false

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

Responses

Updated 12 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?