| Field | Type | Required | Description | Example |
|---|---|---|---|---|
account_id |
T.nilable(::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. | |
categories |
T::Array<Models::Shared::ConnectSessionCreateCategories> | ➖ | The categories of the provider to connect to | [ "ats", "hris", "hrisLegacy", "crm", "iam", "marketing", "lms", "stackOne", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ] |
expires_in |
T.nilable(::Float) | ➖ | How long the session should be valid for in seconds | |
integration_id |
T.nilable(::String) | ➖ | The ID of the specific Auth Config to use for this connect session. When provided, the hub will render on this specific auth config. This is an alternative to using provider and provider_version together. | |
label |
T.nilable(::String) | ➖ | The label to be applied to the account associated with this connect session. | |
metadata |
T.nilable(Models::Shared::ConnectSessionCreateMetadata) | ➖ | The metadata for the connection | |
multiple |
T.nilable(T::Boolean) | ➖ | 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. | |
origin_owner_id |
::String | ✔️ | The origin owner identifier | |
origin_owner_name |
::String | ✔️ | The origin owner name | |
origin_username |
T.nilable(::String) | ➖ | The origin username | |
provider |
T.nilable(::String) | ➖ | The provider to connect to. When used with provider_version, ensures the hub renders on the specific auth config required. Alternatively, use integration_id to target a specific auth config directly. | |
provider_version |
T.nilable(::String) | ➖ | The provider version to connect to. Must be used together with provider to target a specific auth config. Alternatively, use integration_id to target a specific auth config directly. | |
type |
T.nilable(Models::Shared::ConnectSessionCreateType) | ➖ | The connect session account type | [ "PRODUCTION", "TEST" ] |