Interface ClientSessionInterface

ClientSession entity interface

Mirrors macs-node-sdk/lib/clients/models/client-session.js. Represents a pending / active OAuth authorization session. code, refresh_key, and active_id are server-managed.

interface ClientSessionInterface {
    active?: boolean;
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    client: string;
    metadata: { [key: string]: any };
    code?: string;
    code_challenge?: string;
    code_challenge_method?: "S256" | "plain";
    redirect_uri: string;
    expires_at?: string | Date;
}

Hierarchy (View Summary)

Properties

active? external_id? extensors? record_history? id? client metadata code? code_challenge? code_challenge_method? redirect_uri expires_at?

Properties

Optionalactive

active?: boolean

Whether the entity is active

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

client

client: string

Owning Client (required)

metadata

metadata: { [key: string]: any }

OAuth request metadata (scopes, state, etc.) — required

Optional Readonlycode

code?: string

Authorization code issued to the client (read-only after issue)

Optionalcode_challenge

code_challenge?: string

PKCE code challenge

Optionalcode_challenge_method

code_challenge_method?: "S256" | "plain"

PKCE code challenge method

redirect_uri

redirect_uri: string

Redirect URI agreed at authorization (required)

Optionalexpires_at

expires_at?: string | Date

Session expiry

Settings

Member Visibility

On This Page

Properties