StackOne · Schema

ConnectSessionCreate

IntegrationsiPaaS

Properties

Name	Type	Description
expires_in	number	How long the session should be valid for in seconds
metadata	object	The metadata for the connection
categories	array	The categories of the provider to connect to
provider	string	The provider to connect to
origin_owner_id	string	The origin owner identifier
origin_owner_name	string	The origin owner name
origin_username	string	The origin username

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectSessionCreate",
  "title": "ConnectSessionCreate",
  "type": "object",
  "properties": {
    "expires_in": {
      "type": "number",
      "description": "How long the session should be valid for in seconds",
      "default": 1800
    },
    "metadata": {
      "type": "object",
      "description": "The metadata for the connection"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "ats",
          "hris",
          "hris-legacy",
          "crm",
          "marketing",
          "stackone"
        ]
      },
      "description": "The categories of the provider to connect to",
      "example": [
        "ats",
        "hris",
        "hrisLegacy",
        "crm",
        "marketing",
        "stackOne"
      ]
    },
    "provider": {
      "type": "string",
      "description": "The provider to connect to"
    },
    "origin_owner_id": {
      "type": "string",
      "description": "The origin owner identifier"
    },
    "origin_owner_name": {
      "type": "string",
      "description": "The origin owner name"
    },
    "origin_username": {
      "type": "string",
      "description": "The origin username"
    }
  },
  "required": [
    "origin_owner_id",
    "origin_owner_name"
  ]
}