POST
/
connect_sessions
/
authenticate
curl --request POST \
  --url https://api.stackone.com/connect_sessions/authenticate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "<string>"
}'
{
  "id": 123,
  "organization_id": 123,
  "project_id": "<string>",
  "categories": [
    "ats",
    "hris",
    "hrisLegacy",
    "crm",
    "iam",
    "marketing",
    "lms",
    "stackOne",
    "documents",
    "ticketing",
    "screening",
    "messaging"
  ],
  "provider": "<string>",
  "origin_owner_id": "<string>",
  "origin_owner_name": "<string>",
  "origin_username": "<string>",
  "account_id": "<string>",
  "label": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "external_trigger_token": "f0bc3d88-2178-5423-8c81-b81d6c9da824"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
The parameters to authenticate
token
string
required

The token to authenticate with

Response

201
application/json
The details of the authenticated connect session.
id
number
required
organization_id
number
required
project_id
string
required
origin_owner_id
string
required
origin_owner_name
string
required
created_at
string
required
categories
enum<string>[] | null
Available options:
ats,
hris,
hris-legacy,
crm,
iam,
marketing,
lms,
stackone,
documents,
ticketing,
screening,
messaging
Example:
[
  "ats",
  "hris",
  "hrisLegacy",
  "crm",
  "iam",
  "marketing",
  "lms",
  "stackOne",
  "documents",
  "ticketing",
  "screening",
  "messaging"
]
provider
string | null
origin_username
string | null
account_id
string | null
label
string | null
metadata
object | null

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)

external_trigger_token
string | null

External trigger token to be used to trigger actions on the account

Example:

"f0bc3d88-2178-5423-8c81-b81d6c9da824"