Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias AccessProfile

    The access profile of the current session.

    type AccessProfile = {
        adaptations: AccessProfileAdaptation[];
        amSession: "present" | "absent" | "unknown";
        areas: AccessProfileArea[];
        clientId?: string;
        expiresAt?: number;
        flow: AccessProfileFlow;
        grantedScopes: string[];
        measuredOn: string;
        refreshable: boolean;
        requestedScope?: string;
        scopesNotGranted: string[];
        subject?: string;
    }
    Index

    What the library did differently from its defaults.

    amSession: "present" | "absent" | "unknown"

    Whether the access token carries an Access Management session. present and absent are read from the token; unknown when the token is not readable.

    Every area of the API and whether the session can reach it.

    clientId?: string

    The OAuth 2.0 client the access token was issued to, if known.

    expiresAt?: number

    When the access token expires, in milliseconds since the epoch.

    How the credential was obtained.

    grantedScopes: string[]

    The scopes granted according to the token response.

    measuredOn: string

    The date the measured constants behind the profile were last measured (YYYY-MM-DD).

    refreshable: boolean

    Whether the session holds a refresh token. A session without one ends when the access token expires.

    requestedScope?: string

    The scope the library requested, if it made the request and it differs from what was granted.

    scopesNotGranted: string[]

    The requested scopes the token does not carry. Not an error: a client may grant less than it is asked for.

    subject?: string

    Who is logged in, if known.