Skip to main content
POST
/
core.v1.SessionsService
/
GetSession
cURL
curl -X POST "https://api.joinformal.com/core.v1.SessionsService/GetSession" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "session": {
    "id": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "duration": "<string>",
    "sessionStatus": "active",
    "network": {
      "clientIpAddress": "<string>",
      "serverIpAddress": "<string>"
    },
    "sidecar": {
      "id": "<string>",
      "name": "<string>",
      "technology": "<string>"
    },
    "user": {
      "type": "<string>",
      "username": "<string>",
      "formal": {
        "user": {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "type": "<string>",
          "groups": [
            "<string>"
          ],
          "externalIds": [
            "<string>"
          ]
        },
        "endUser": {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "type": "<string>",
          "groups": [
            "<string>"
          ],
          "externalIds": [
            "<string>"
          ]
        }
      },
      "native": {
        "username": "<string>"
      }
    },
    "resource": {
      "type": "<string>",
      "id": "<string>",
      "name": "<string>",
      "technology": "<string>"
    },
    "connector": {
      "id": "<string>",
      "name": "<string>"
    }
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
sessionId
string
Minimum string length: 1

Response

Success

session
session · object