Skip to content
Admin API reference
/
/V4 Session

Create a new session under a given site

Request

Creates a new session under a given site.

Security
ZephrHmacHttp
Path
sitestringrequired

The site ID

Bodyapplication/json
identifiersobjectrequired
Example:
{
  "email_address": "joe.blow@company.com"
}
validatorsobjectrequired
Example:
{
  "password": "mysecurepassword123"
}
{
  "identifiers": {
    "email_address": "joe.blow@company.com"
  },
  "validators": {
    "password": "mysecurepassword123"
  }
}

Responses

OK

Headers
any
Bodyapplication/json
tenantIdstring
Example:"company"
subTenantIdstring
Example:"company|demo"
suppliedboolean
Example:false
expiryDatestring
Example:"2025-02-08 14:29 PM UTC"
startDatestring
Example:"2024-02-08 14:29 PM UTC"
authenticatedboolean
Example:true
statestring
Enum:"anonymous""recognised""partially_registered""authenticated"
Example:"authenticated"
devicestring
Example:"pc"
browserstring
Example:"Chrome"
osstring
Example:"Mac OSX"
citystring
Example:"London"
geoStatestring
Example:"London"
deviceNamestring
Example:"Apple Macintosh"
countrystring

ISO-3166-2 country code

Example:"GB"
session_idstring
Example:"26a73b7a-f7d0-48d8-85dd-a04b07313895"
user_idstring
Example:"UU0123456789ABCD"
Response
{
  "expiryDate": "2018-11-15 14:29 PM UTC",
  "startDate": "2017-11-15 14:29 PM UTC",
  "authenticated": true,
  "session_id": "SS0123456789ABCD",
  "user_id": "UU0123456789ABCD"
}