Skip to main content
POST
/
connect_sessions
/
authenticate
Authenticate Connect Session
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": "<string>",
  "project_id": "<string>",
  "origin_owner_id": "<string>",
  "origin_owner_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "categories": [
    "ats",
    "hris",
    "hrisLegacy",
    "crm",
    "iam",
    "marketing",
    "lms",
    "stackOne",
    "documents",
    "ticketing",
    "screening",
    "messaging",
    "accounting",
    "scheduling"
  ],
  "provider": "<string>",
  "origin_username": "<string>",
  "account_id": "<string>",
  "label": "<string>",
  "metadata": {},
  "external_trigger_token": "f0bc3d88-2178-5423-8c81-b81d6c9da824",
  "type": [
    "PRODUCTION",
    "TEST"
  ],
  "integration_id": "<string>",
  "connector_profile_id": "<string>",
  "latest_connection_attempt": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "account_secure_id": "<string>",
    "oauth_error_code": "<string>",
    "oauth_error_description": "<string>"
  }
}

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

The details of the authenticated connect session.

​
id
number
required
​
organization_id
string
required
​
project_id
string
required
​
origin_owner_id
string
required
​
origin_owner_name
string
required
​
created_at
string<date-time>
required
​
categories
enum<string>[] | null
Available options:
ats,
hris,
hris-legacy,
crm,
iam,
marketing,
lms,
stackone,
documents,
ticketing,
screening,
messaging,
accounting,
scheduling,
null
Example:
[
  "ats",
  "hris",
  "hrisLegacy",
  "crm",
  "iam",
  "marketing",
  "lms",
  "stackOne",
  "documents",
  "ticketing",
  "screening",
  "messaging",
  "accounting",
  "scheduling"
]
​
provider
string | null
​
origin_username
string | null
​
account_id
string | null
​
label
string | null
​
metadata
object

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"

​
type
enum<string> | null

The connect session account type

Available options:
production,
test,
unmapped_value,
null
Example:
["PRODUCTION", "TEST"]
​
integration_id
string | null
deprecated

Deprecated: use connector_profile_id instead. The integration ID (UUID) associated with this connect session.

​
connector_profile_id
string | null

The connector profile ID associated with this connect session

​
latest_connection_attempt
object

The most recent connection attempt initiated against this session, if any. Use this to poll for OAuth completion: when status is "authenticated", the resulting account is at account_secure_id.