SessionScopes | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Interface SessionScopes

    Extend this interface to define the format of your own sessions

    interface SessionScopes {
        "platform:incomplete-account": {
            badPasswordTime: null | Instant;
            failedchecks: PasswordCheck[];
            returnTo: string;
            user: number;
        };
        "platform:uploadsession": { chunkSize: number; manifest: UploadManifest };
        "system:oauth2": {
            client_scope?: string;
            code_verifier: string;
            finalreturnurl: string;
            metadata_url?: string;
            oauthconfig: {
                authorizeurl: string;
                authtokenurl: string;
                clientid: string;
                clientsecret: string;
                redirecturl: string;
            };
            requeststart: Date;
            tokeninfo?: OAuth2Tokens;
            user_data?: Record<string, unknown>;
        };
        "wrd:openid.idpstate": {
            cbUrl: string;
            clientid: number;
            code_challenge: null
            | string;
            code_challenge_method: null | "plain" | "S256";
            nonce: null | string;
            scopes: string[];
            state: null | string;
            user?: number;
        };
        [key: string]: Record<string, unknown>;
    }

    Indexable

    • [key: string]: Record<string, unknown>
    Index

    Properties

    "platform:incomplete-account": {
        badPasswordTime: null | Instant;
        failedchecks: PasswordCheck[];
        returnTo: string;
        user: number;
    }

    Type declaration

    • badPasswordTime: null | Instant

      Time of the bad password

    • failedchecks: PasswordCheck[]

      Failed checks

    • returnTo: string

      Return url

    • user: number

      User id to login

    "platform:uploadsession": { chunkSize: number; manifest: UploadManifest }
    "system:oauth2": {
        client_scope?: string;
        code_verifier: string;
        finalreturnurl: string;
        metadata_url?: string;
        oauthconfig: {
            authorizeurl: string;
            authtokenurl: string;
            clientid: string;
            clientsecret: string;
            redirecturl: string;
        };
        requeststart: Date;
        tokeninfo?: OAuth2Tokens;
        user_data?: Record<string, unknown>;
    }
    "wrd:openid.idpstate": {
        cbUrl: string;
        clientid: number;
        code_challenge: null | string;
        code_challenge_method: null | "plain" | "S256";
        nonce: null | string;
        scopes: string[];
        state: null | string;
        user?: number;
    }

    Type declaration

    • cbUrl: string
    • clientid: number
    • code_challenge: null | string
    • code_challenge_method: null | "plain" | "S256"
    • nonce: null | string
    • scopes: string[]
    • state: null | string
    • Optionaluser?: number

      User id to set