ping-identity
    Preparing search index...

    Type Alias PushCredential

    A registered push MFA credential stored on the device.

    Returned by PushClient.addCredentialFromUri, PushClient.getCredential, PushClient.getCredentials, and PushClient.saveCredential.

    The sharedSecret field is intentionally omitted — it is kept native-side only and never crosses the bridge.

    const credential = await client.addCredentialFromUri('pushauth://...');
    console.log(credential.issuer, credential.accountName);
    type PushCredential = {
        accountName: string;
        backgroundColor: string | null;
        createdAt: number;
        displayAccountName: string | null;
        displayIssuer: string | null;
        id: string;
        imageURL: string | null;
        isLocked: boolean;
        issuer: string;
        lockingPolicy: string | null;
        platform: PushPlatform;
        policies: string | null;
        resourceId: string | null;
        serverEndpoint: string | null;
        userId: string | null;
    }
    Index

    Properties

    accountName backgroundColor createdAt displayAccountName displayIssuer id imageURL isLocked issuer lockingPolicy platform policies resourceId serverEndpoint userId

    Properties

    accountName: string

    Account name (e.g. username or email address).

    backgroundColor: string | null

    Optional background color hint for display (CSS hex or named color).

    createdAt: number

    Credential creation timestamp in milliseconds since epoch.

    displayAccountName: string | null

    Display name for the account, may override accountName in UI.

    null when not set by the server. Both platforms may return null for this field.

    displayIssuer: string | null

    Display name for the issuer, may override issuer in UI.

    null when not set by the server. Both platforms may return null for this field.

    id: string

    Unique credential identifier.

    imageURL: string | null

    Optional credential image URL for display purposes.

    isLocked: boolean

    Whether the credential is currently locked.

    issuer: string

    Issuer name (e.g. service or application name).

    lockingPolicy: string | null

    Serialized locking policy string, if any, for this credential.

    platform: PushPlatform

    Push platform identifier.

    policies: string | null

    Serialized policy string, if any, associated with this credential.

    resourceId: string | null

    Resource identifier for the protected resource.

    null on Android — the Android PushCredential SDK class does not expose this field. Non-null on iOS.

    serverEndpoint: string | null

    Server endpoint URL used to communicate with the push service.

    null on Android — the Android PushCredential SDK class does not expose this field. Non-null on iOS.

    userId: string | null

    Optional user identifier associated with the credential.

    Settings

    Member Visibility

    On This Page

    Properties