Skip to main content
Docs

SignedInSessionResource

The SignedInSessionResource is a type that represents sessions for users who have completed the full sign-in flow. It's a union of ActiveSessionResource and PendingSessionResource.

type SignedInSessionResource = ActiveSessionResource | PendingSessionResource

It contains all properties from the Session object, but guarantees that the user property is non-null and the status is either active or pending.

ActiveSessionResource

An active session means the user is fully logged in and ready to use your app.

  • Name
    status
    Type
    'active'
    Description

    Always 'active' for this session type.

  • Name
    user
    Type
    User
    Description

    The user associated with the session. This property is guaranteed to be non-null for active sessions.

PendingSessionResource

A pending session means the user has logged in but needs to complete one or more additional verification steps (like authenticating with a second factor) before they have full access.

  • Name
    status
    Type
    'pending'
    Description

    Always 'pending' for this session type.

  • Name
    user
    Type
    User
    Description

    The user associated with the session. This property is guaranteed to be non-null for pending sessions.

  • Name
    currentTask
    Type
    SessionTask
    Description

    The current pending task for the session. Read more about session tasks.

Feedback

What did you think of this content?

Last updated on