deviceClient

Returns a device management object containing methods for handling various device types

  • Parameters

    • config: ConfigOptions

      The configuration options for the device client

    Returns {
        bound: {
            delete: (query: BoundDeviceQuery) => Promise<null | { error: unknown }>;
            get: (
                query: GetBoundDevicesQuery,
            ) => Promise<Device[] | { error: unknown }>;
            update: (query: BoundDeviceQuery) => Promise<Device | { error: unknown }>;
        };
        oath: {
            delete: (
                query: RetrieveOathQuery & { device: OathDevice },
            ) => Promise<null | { error: unknown }>;
            get: (
                query: RetrieveOathQuery,
            ) => Promise<OathDevice[] | { error: unknown }>;
        };
        profile: {
            delete: (
                query: ProfileDevicesQuery,
            ) => Promise<null | { error: unknown }>;
            get: (
                query: GetProfileDevices,
            ) => Promise<ProfileDevice[] | { error: unknown }>;
            update: (
                query: ProfileDevicesQuery,
            ) => Promise<ProfileDevice | { error: unknown }>;
        };
        push: {
            delete: (
                query: DeleteDeviceQuery,
            ) => Promise<null | { error: unknown }>;
            get: (
                query: PushDeviceQuery,
            ) => Promise<PushDevice[] | { error: unknown }>;
        };
        webAuthn: {
            delete: (
                query: WebAuthnQuery & {
                    device: WebAuthnDevice | UpdatedWebAuthnDevice;
                },
            ) => Promise<null | { error: unknown }>;
            get: (
                query: WebAuthnQuery,
            ) => Promise<WebAuthnDevice[] | { error: unknown }>;
            update: (
                query: WebAuthnQuery & { device: WebAuthnDevice },
            ) => Promise<UpdatedWebAuthnDevice | { error: unknown }>;
        };
    }

    Methods for handling various device types

    • bound: {
          delete: (query: BoundDeviceQuery) => Promise<null | { error: unknown }>;
          get: (
              query: GetBoundDevicesQuery,
          ) => Promise<Device[] | { error: unknown }>;
          update: (query: BoundDeviceQuery) => Promise<Device | { error: unknown }>;
      }

      Bound devices management methods.

      • delete: (query: BoundDeviceQuery) => Promise<null | { error: unknown }>

        Deletes a bound device based on the provided query.

        delete

      • get: (query: GetBoundDevicesQuery) => Promise<Device[] | { error: unknown }>

        Retrieves bound devices based on the specified query.

        get

      • update: (query: BoundDeviceQuery) => Promise<Device | { error: unknown }>

        Updates the name of a bound device based on the provided query.

        update

    • oath: {
          delete: (
              query: RetrieveOathQuery & { device: OathDevice },
          ) => Promise<null | { error: unknown }>;
          get: (
              query: RetrieveOathQuery,
          ) => Promise<OathDevice[] | { error: unknown }>;
      }

      Oath device management methods.

      • delete: (
            query: RetrieveOathQuery & { device: OathDevice },
        ) => Promise<null | { error: unknown }>

        Deletes an Oath device based on the provided query and device information.

        delete

      • get: (query: RetrieveOathQuery) => Promise<OathDevice[] | { error: unknown }>

        Retrieves Oath devices based on the specified query.

        get

    • profile: {
          delete: (
              query: ProfileDevicesQuery,
          ) => Promise<null | { error: unknown }>;
          get: (
              query: GetProfileDevices,
          ) => Promise<ProfileDevice[] | { error: unknown }>;
          update: (
              query: ProfileDevicesQuery,
          ) => Promise<ProfileDevice | { error: unknown }>;
      }
    • push: {
          delete: (query: DeleteDeviceQuery) => Promise<null | { error: unknown }>;
          get: (query: PushDeviceQuery) => Promise<PushDevice[] | { error: unknown }>;
      }

      Push device management methods.

      • delete: (query: DeleteDeviceQuery) => Promise<null | { error: unknown }>

        Deletes a Push device based on the provided query.

        delete

      • get: (query: PushDeviceQuery) => Promise<PushDevice[] | { error: unknown }>

        Retrieves Push devices based on the specified query.

        get

    • webAuthn: {
          delete: (
              query: WebAuthnQuery & {
                  device: WebAuthnDevice | UpdatedWebAuthnDevice;
              },
          ) => Promise<null | { error: unknown }>;
          get: (
              query: WebAuthnQuery,
          ) => Promise<WebAuthnDevice[] | { error: unknown }>;
          update: (
              query: WebAuthnQuery & { device: WebAuthnDevice },
          ) => Promise<UpdatedWebAuthnDevice | { error: unknown }>;
      }

      WebAuthn device management methods.