Skip to main content
Version: v41

sessionResponse

Session response object

countinteger

Session count.

Example: 1
items object[]
  • Array [
  • idstring<uuid>

    Session ID

    user_idstring<uuid>

    User ID

    source_idstring<uuid>

    Source ID

    parent_session_idstring<uuid>

    Parent session ID, only specified in sessions of type child

    Example: 44f2f78a-4604-4803-b2b7-61807480e5cd
    domainstring

    Domain type

    Example: privx-ui
    usernamestring

    Name of the user

    Example: alice
    remote_addrstring

    Clients remote address

    Example: 127.0.0.1
    user_agentstring

    User agent identification

    Example: Mozilla....
    typestring

    Type of session

    Possible values: [login, sso, child]

    Example: login
    createdstring<date-time>

    When the session was created

    Example: 2022-01-01T09:17:16Z
    updatedstring<date-time>

    When the session was updated

    Example: 2022-01-01T09:17:16Z
    expiresstring<date-time>

    When the session will expire

    Example: 2022-01-01T09:17:16Z
    token_expiresstring<date-time>

    When the token will expire

    Example: 2022-01-01T09:17:16Z
    logged_outboolean

    Signals if session has been logged out or not

    Example: false
    currentboolean

    Indicate which of the users sessions is the one to list the sessions

    Example: false
  • ]
  • sessionResponse
    {
    "count": 1,
    "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parent_session_id": "44f2f78a-4604-4803-b2b7-61807480e5cd",
    "domain": "privx-ui",
    "username": "alice",
    "remote_addr": "127.0.0.1",
    "user_agent": "Mozilla....",
    "type": "login",
    "created": "2022-01-01T09:17:16Z",
    "updated": "2022-01-01T09:17:16Z",
    "expires": "2022-01-01T09:17:16Z",
    "token_expires": "2022-01-01T09:17:16Z",
    "logged_out": false,
    "current": false
    }
    ]
    }