@schibsted/account-sdk-browser
    Preparing search index...

    Type Alias SessionSuccessResponse

    Successful response returned from Account#hasSession.

    result means the has-session call itself succeeded. result: true means the user is connected to the merchant; result: false means a session may exist, but the user is not connected to this client.

    type SessionSuccessResponse = {
        baseDomain?: string;
        clientAgreementAccepted?: boolean;
        code?: number;
        defaultAgreementAccepted?: boolean;
        description?: string;
        displayName?: string;
        expiresIn?: number;
        familyName?: string;
        gender?: string;
        givenName?: string;
        id?: string;
        pairId?: string;
        photo?: string;
        result: boolean;
        sdrn?: string;
        serverTime?: number;
        sig?: string;
        sp_id?: string;
        tracking?: boolean;
        type?: string;
        userId?: SessionUserId;
        userStatus?: string;
        uuid?: string;
    }
    Index

    Properties

    baseDomain? clientAgreementAccepted? code? defaultAgreementAccepted? description? displayName? expiresIn? familyName? gender? givenName? id? pairId? photo? result sdrn? serverTime? sig? sp_id? tracking? type? userId? userStatus? uuid?

    Properties

    baseDomain?: string

    Cookie base domain used as the SP_ID cookie domain fallback. Example: 'spid.no'.

    clientAgreementAccepted?: boolean

    Whether the client agreement is accepted. Example: true.

    code?: number

    Response status code. Example: 200.

    defaultAgreementAccepted?: boolean

    Whether the default agreement is accepted. Example: true.

    description?: string

    Human-readable response description. Example: 'OK'.

    displayName?: string

    User display name. Example: 'batman'.

    expiresIn?: number

    Session response TTL in seconds. Example: 300.

    familyName?: string

    User family name. Example: 'Wayne'.

    gender?: string

    User gender value. Example: 'male', 'female', 'undisclosed'.

    givenName?: string

    User given name. Example: 'Bruce'.

    id?: string

    Legacy session id. Obsolete. Example: '58eca10fdbb9f6df72c3368f'.

    pairId?: string

    Pairwise user id for this client. Example: 'b2a23caa...'.

    photo?: string

    User profile photo URL. Example: 'http://www.srv.com/some/picture.jpg' .

    result: boolean

    Is the user connected to the merchant? This means the merchant id is in the list of merchants connected to this user.

    sdrn?: string

    User SDRN. Example: 'sdrn:spid.no:user:12345'.

    serverTime?: number

    Server time as a Unix timestamp in seconds. Example: 1506285759.

    sig?: string

    Example: 'NCdzXaz4ZRb7...' The sig parameter is a concatenation of an HMAC SHA-256 signature string, a dot (.) and a base64url encoded JSON object (session). http://techdocs.spid.no/sdks/js/response-signature-and-validation/

    sp_id?: string

    Session token used for the SP_ID cookie. Example: 'eyJjbGllbnRfaWQ...'.

    tracking?: boolean

    Whether tracking is enabled for this session. Example: true.

    type?: string

    Response type. Example: 'OK'.

    userId?: SessionUserId

    A numeric user id which is unique per realm (country). Example: 37162

    userStatus?: string

    Connection status string. Deprecated; use Account.isConnected(). Example: 'connected'.

    uuid?: string

    Globally unique user id. Example: 'b3b23aa7-34f2-5d02-a10e-5a3455c6ab2c'

    Settings

    Member Visibility

    On This Page

    Properties