Skip to main content
Docs

The Backend Session object

The Backend Session object is similar to the Session object as it is an abstraction over an HTTP session and models the period of information exchange between a user and the server. However, the Backend Session object is different as it is used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier for the Session.

  • Name
    clientId
    Type
    string
    Description

    The ID of the client associated with the Session.

  • Name
    userId
    Type
    string
    Description

    The ID of the user associated with the Session.

  • Name
    status
    Type
    string
    Description

    The current state of the Session.

  • Name
    lastActiveAt
    Type
    number
    Description

    The time the session was last active on the Client.

  • Name
    lastActiveOrganizationId
    Type
    string | undefined
    Description

    The ID of the last active organization.

  • Name
    actor
    Type
    ActJWTClaim | null
    Description

    The JWT actor for the session. Holds identifier for the user that is impersonating the current user. Read more about impersonation.

  • Name
    latestActivity
    Type
    SessionActivity
    Description

    An object that provides additional information about this session, focused around user activity data.

  • Name
    expireAt
    Type
    number
    Description

    The date when the Session will expire.

  • Name
    abandonAt
    Type
    number
    Description

    The date when the Session will be abandoned.

  • Name
    createdAt
    Type
    number
    Description

    The date when the Session was first created.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the Session was last updated.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on