Member Junction
    Preparing search index...

    Interface IAuthProvider

    Interface for authentication providers in MemberJunction Enables support for any OAuth 2.0/OIDC compliant provider

    interface IAuthProvider {
        audience: string;
        clientId?: string;
        domain?: string;
        issuer: string;
        jwksUri: string;
        name: string;
        extractUserInfo(payload: JwtPayload): AuthUserInfo;
        getSigningKey(header: JwtHeader, callback: SigningKeyCallback): void;
        matchesIssuer(issuer: string): boolean;
        validateConfig(): boolean;
    }

    Implemented by

    Index

    Properties

    audience clientId? domain? issuer jwksUri name

    Methods

    extractUserInfo getSigningKey matchesIssuer validateConfig

    Properties

    audience: string

    The expected audience for tokens from this provider

    clientId?: string

    OAuth client ID for this provider (optional, used by OAuth proxy for upstream authentication)

    domain?: string

    Provider domain, where the provider hosts its OAuth endpoints somewhere other than its issuer (optional, used by the OAuth proxy). Cognito is the case that needs it: its issuer is the user-pool URL, but /authorize and /token live on the hosted-UI domain.

    issuer: string

    The issuer URL for this provider (must match the 'iss' claim in tokens)

    jwksUri: string

    The JWKS endpoint URL for retrieving signing keys

    name: string

    Unique name identifier for this provider

    Methods

    • Gets the signing key for token verification

      Parameters

      • header: JwtHeader
      • callback: SigningKeyCallback

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods