ping-identity
    Preparing search index...

    Type Alias IdpCollector

    Social login / external IdP collector.

    Corresponds to the native SOCIAL_LOGIN_BUTTON server type.

    The key field is set to idpId (the stable server-assigned identifier) rather than the native collector's own .id property, which returns a new UUID on every access.

    Handled entirely by @ping-identity/rn-external-idp — appears as executionMode: 'integration_required' and kind: 'integration' in normalized collectors.

    type IdpCollector = {
        idpEnabled: boolean;
        idpId: string;
        idpType: "GOOGLE" | "FACEBOOK" | "APPLE" | string;
        key: string;
        label: string;
        link?: string;
        raw?: Record<string, unknown>;
        type: "SOCIAL_LOGIN_BUTTON";
    }
    Index

    Properties

    idpEnabled idpId idpType key label link? raw? type

    Properties

    idpEnabled: boolean

    Whether the IdP is currently enabled.

    idpId: string

    Server IdP identifier (same as key).

    idpType: "GOOGLE" | "FACEBOOK" | "APPLE" | string

    Provider type string.

    Verified against iOS DavinciPlugin/Constants.swift and Android IdpCollector bytecode — the SDK registers 'GOOGLE', 'FACEBOOK', and 'APPLE' (uppercase). 'APPLE' is iOS-only; Android has no native Apple sign-in handler. The union is left open (| string) to accommodate future providers without a breaking change.

    key: string

    Stable server-assigned IdP identifier, used as the form field key.

    label: string

    Human-readable button label (e.g. 'Sign in with Google').

    link?: string

    IdP authentication URL (informational — not used directly by JS).

    raw?: Record<string, unknown>
    type: "SOCIAL_LOGIN_BUTTON"

    Settings

    Member Visibility

    On This Page

    Properties