Create Connect Session
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
The origin owner identifier
The origin owner name
The categories of the provider to connect to
ats
, hris
, hris-legacy
, crm
, iam
, marketing
, lms
, stackone
, documents
, ticketing
, screening
[
"ats",
"hris",
"hrisLegacy",
"crm",
"iam",
"marketing",
"lms",
"stackOne",
"documents",
"ticketing",
"screening"
]
The provider to connect to
The origin username
The unique identifier for the account associated with this connect session. When this field is present, the hub will launch in edit mode using the retrieved token.
How long the session should be valid for in seconds
The metadata for the connection
If set, this connect session will allow creation of multiple accounts with the same origin owner id and provider. Has no effect if account_id is set.
The label to be applied to the account associated with this connect session.
Response
ats
, hris
, hris-legacy
, crm
, iam
, marketing
, lms
, stackone
, documents
, ticketing
, screening
[
"ats",
"hris",
"hrisLegacy",
"crm",
"iam",
"marketing",
"lms",
"stackOne",
"documents",
"ticketing",
"screening"
]
Arbitrary set of key and values defined during the session token creation. This can be used to tag an account (eg. based on their pricing plan)
Was this page helpful?