@faable/auth-js - v2.8.1
    Preparing search index...

    Interface JwtClaims

    Decoded payload of the session's access token, as returned by FaableAuthClient.getClaims. Standard JWT / OAuth claims are typed; custom claims set by the tenant (a connection's claims_mapping or an Action's api.accessToken.setCustomClaim) surface through the index signature — narrow them with the generic parameter of getClaims.

    Decoded locally, NOT signature-verified: good for UI decisions ("which station am I in?"), never for authorization — the resource server that receives the token is what validates it.

    interface JwtClaims {
        aud?: string | string[];
        client_id?: string;
        exp?: number;
        iat?: number;
        iss?: string;
        permissions?: string;
        roles?: string[];
        scope?: string;
        sub?: string;
        teams?: string[];
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    aud? client_id? exp? iat? iss? permissions? roles? scope? sub? teams?

    Properties

    aud?: string | string[]

    Audience — the Api identifier or ${iss}/userinfo.

    client_id?: string
    exp?: number

    Expiry, seconds since the epoch.

    iat?: number

    Issued at, seconds since the epoch.

    iss?: string

    Issuer — the Faable Auth tenant URL.

    permissions?: string

    Space-separated permissions (Auth0 access_token_authz dialect).

    roles?: string[]

    Role names, when the Api opted in.

    scope?: string

    Space-separated granted scopes.

    sub?: string

    Subject — the user id (user_…) or, for M2M tokens, the client id.

    teams?: string[]

    Team slugs, when the Api opted in.

    Settings

    Member Visibility

    On This Page

    Properties