Auth0 client interface.

interface Auth0Client {
    addOns?: ClientAddOns;
    allowedClients?: string[];
    allowedLogoutUrls?: string[];
    allowedOrigins?: string[];
    appType?: string;
    auth0Id?: string;
    callbacks?: string[];
    clientAliases?: string[];
    clientMetadata?: Record<string, any>;
    crossOriginAuth?: boolean;
    crossOriginLoc?: string;
    customLoginPage?: string;
    customLoginPageOn?: boolean;
    customLoginPagePreview?: string;
    description?: string;
    disabled?: boolean;
    encryptionKey?: { cert?: string; pub?: string; subject?: string };
    formTemplate?: string;
    global?: boolean;
    grantTypes?: string[];
    id: string;
    initiateLoginUri?: string;
    isFirstParty?: boolean;
    jwtConfiguration?: Auth0JwtConfiguration;
    logoUri?: string;
    mobile?: {
        android?: {
            appPackageName?: string;
            sha256CertFingerprints?: string[];
        };
        ios?: { appBundleIdentifier?: string; teamId?: string };
    };
    name: string;
    nativeSocialLogin?: {
        apple?: { enabled?: boolean };
        facebook?: { enabled?: boolean };
    };
    oidcBackchannelLogout?: { backchannelLogoutUrls?: string[] };
    oidcConformant?: boolean;
    organizationRequireBehavior?: string;
    organizationUsage?: OrganizationUsageAuthenticationTransaction;
    refreshToken?: {
        expirationType?: string;
        idleTokenLifetime?: number;
        infiniteIdleTokenLifetime?: boolean;
        infiniteTokenLifetime?: boolean;
        leeway?: number;
        rotationType?: string;
        tokenLifetime?: number;
    };
    secret?: string;
    signingKeys?: Record<string, any>[];
    sso?: boolean;
    ssoDisabled?: boolean;
    supportedIdp?: string[];
    tenant?: string;
    tokenEndpointAuthMethod?: string;
    webOrigins?: string[];
}

Hierarchy (View Summary)

Properties

addOns?: ClientAddOns
allowedClients?: string[]
allowedLogoutUrls?: string[]
allowedOrigins?: string[]
appType?: string
auth0Id?: string
callbacks?: string[]
clientAliases?: string[]
clientMetadata?: Record<string, any>
crossOriginAuth?: boolean
crossOriginLoc?: string
customLoginPage?: string
customLoginPageOn?: boolean
customLoginPagePreview?: string
description?: string
disabled?: boolean
encryptionKey?: { cert?: string; pub?: string; subject?: string }
formTemplate?: string
global?: boolean
grantTypes?: string[]
id: string
initiateLoginUri?: string
isFirstParty?: boolean
jwtConfiguration?: Auth0JwtConfiguration
logoUri?: string
mobile?: {
    android?: { appPackageName?: string; sha256CertFingerprints?: string[] };
    ios?: { appBundleIdentifier?: string; teamId?: string };
}
name: string
nativeSocialLogin?: {
    apple?: { enabled?: boolean };
    facebook?: { enabled?: boolean };
}
oidcBackchannelLogout?: { backchannelLogoutUrls?: string[] }
oidcConformant?: boolean
organizationRequireBehavior?: string
refreshToken?: {
    expirationType?: string;
    idleTokenLifetime?: number;
    infiniteIdleTokenLifetime?: boolean;
    infiniteTokenLifetime?: boolean;
    leeway?: number;
    rotationType?: string;
    tokenLifetime?: number;
}
secret?: string
signingKeys?: Record<string, any>[]
sso?: boolean
ssoDisabled?: boolean
supportedIdp?: string[]
tenant?: string
tokenEndpointAuthMethod?: string
webOrigins?: string[]