Clerk.Session

The Clerk session resource, with the fields listed in coverage.json.

The session token is deliberately absent: tokens are only available through Clerk.requestToken, which round-trips to ClerkJS so the token is always fresh. The session's user is not repeated here either; it is the sibling user field of Clerk.SignedIn.

type alias Session =

{ id : String

, status : String

, expireAt : Posix

, abandonAt : Posix

, lastActiveAt : Posix

, createdAt : Posix

, updatedAt : Posix

, factorVerificationAge : Maybe FactorVerificationAge

, lastActiveOrganizationId : Maybe String

, actor : Maybe Actor

, tasks : List String

, currentTask : Maybe String

, publicUserData : PublicUserData

}

The active Clerk session.

status is passed through as ClerkJS reports it (for example "active"), so a new status value never fails to decode. tasks holds the pending session task keys ("choose-organization", "reset-password", "setup-mfa") and currentTask the one ClerkJS is currently asking for. actor is set while an admin is impersonating the user.

type alias FactorVerificationAge =

{ firstFactorAge : Int

, secondFactorAge : Int

}

Minutes since the first and second authentication factors were verified, as ClerkJS reports them for step-up checks. Nothing on the session when ClerkJS has no age information.

decoder : Decoder Session

Decode a Session from the JSON the shim sends.

{ "id": "sess_1"
, "status": "active"
, "expireAt": 1700003600000
, "abandonAt": 1702592000000
, "lastActiveAt": 1700000000000
, "createdAt": 1699990000000
, "updatedAt": 1700000000000
, "factorVerificationAge": { "firstFactorAge": 5, "secondFactorAge": -1 }
, "lastActiveOrganizationId": "org_1"
, "actor": null
, "tasks": []
, "currentTask": null
, "publicUserData": PublicUserData
}

Timestamps arrive as epoch milliseconds. factorVerificationAge, actor, lastActiveOrganizationId and currentTask accept null.

alexbruf/elm-clerk/2.0.0

Clerk.Session

Modules

Core

Resources