| Field | Type | Required | Description | Example |
|---|---|---|---|---|
categories |
array<Components\Categories> | ➖ | The categories of the provider to connect to | [ "ats", "hris", "hrisLegacy", "crm", "iam", "marketing", "lms", "stackOne", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ] |
provider |
?string | ➖ | The provider to connect to | |
providerVersion |
?string | ➖ | The provider version to connect to | |
originOwnerId |
string | ✔️ | The origin owner identifier | |
originOwnerName |
string | ✔️ | The origin owner name | |
originUsername |
?string | ➖ | The origin username | |
accountId |
?string | ➖ | 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. | |
expiresIn |
?float | ➖ | How long the session should be valid for in seconds | |
metadata |
?Components\Metadata | ➖ | The metadata for the connection | |
multiple |
?bool | ➖ | 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. | |
label |
?string | ➖ | The label to be applied to the account associated with this connect session. | |
type |
?Components\Type | ➖ | The connect session account type | [ "PRODUCTION", "TEST" ] |
integrationId |
?string | ➖ | The integration ID associated with this connect session |