ping-identity
    Preparing search index...

    Interface DeviceClient

    Reusable client for device management operations.

    Created via createDeviceClient. Each client is bound to a single SSO session (token) and maintains a native handle on both iOS and Android.

    The client follows a handle-based lifecycle: calling dispose releases native resources and invalidates the client.

    const client = createDeviceClient({ ... });
    try {
    const oathDevices = await client.oath.get();
    } finally {
    await client.dispose();
    }
    interface DeviceClient {
        bound: DeviceRepository<BoundDevice>;
        oath: DeviceRepository<DeviceBase>;
        profile: DeviceRepository<ProfileDevice>;
        push: DeviceRepository<DeviceBase>;
        webAuthn: DeviceRepository<WebAuthnDevice>;
        dispose(): Promise<void>;
    }
    Index

    Properties

    Repository for cryptographically bound devices.

    Repository for OATH (TOTP / HOTP) authenticator devices.

    Repository for device profile records (non-MFA).

    Repository for push notification devices.

    Repository for FIDO2 / WebAuthn credentials.

    Methods

    • Releases native resources associated with this client.

      Returns Promise<void>

      Safe to call multiple times. After dispose(), any further operations on this client's repositories will reject.