cloudflare/resources/zero-trust/devices/devices.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as DevicesAPI from 'cloudflare/resources/zero-trust/devices/devices';
import * as DEXTestsAPI from 'cloudflare/resources/zero-trust/devices/dex-tests';
import * as NetworksAPI from 'cloudflare/resources/zero-trust/devices/networks';
import * as OverrideCodesAPI from 'cloudflare/resources/zero-trust/devices/override-codes';
import * as RevokeAPI from 'cloudflare/resources/zero-trust/devices/revoke';
import * as SettingsAPI from 'cloudflare/resources/zero-trust/devices/settings';
import * as UnrevokeAPI from 'cloudflare/resources/zero-trust/devices/unrevoke';
import * as PoliciesAPI from 'cloudflare/resources/zero-trust/devices/policies/policies';
import * as PostureAPI from 'cloudflare/resources/zero-trust/devices/posture/posture';
import { SinglePage } from 'cloudflare/pagination';
export declare class Devices extends APIResource {
    dexTests: DEXTestsAPI.DEXTests;
    networks: NetworksAPI.Networks;
    policies: PoliciesAPI.Policies;
    posture: PostureAPI.Posture;
    revoke: RevokeAPI.Revoke;
    settings: SettingsAPI.Settings;
    unrevoke: UnrevokeAPI.Unrevoke;
    overrideCodes: OverrideCodesAPI.OverrideCodes;
    /**
     * Fetches a list of enrolled devices.
     */
    list(params: DeviceListParams, options?: Core.RequestOptions): Core.PagePromise<DevicesSinglePage, Device>;
    /**
     * Fetches details for a single device.
     */
    get(deviceId: string, params: DeviceGetParams, options?: Core.RequestOptions): Core.APIPromise<DeviceGetResponse>;
}
export declare class DevicesSinglePage extends SinglePage<Device> {
}
export interface Device {
    /**
     * Device ID.
     */
    id?: string;
    /**
     * When the device was created.
     */
    created?: string;
    /**
     * True if the device was deleted.
     */
    deleted?: boolean;
    device_type?: 'windows' | 'mac' | 'linux' | 'android' | 'ios';
    /**
     * IPv4 or IPv6 address.
     */
    ip?: string;
    /**
     * The device's public key.
     */
    key?: string;
    /**
     * When the device last connected to Cloudflare services.
     */
    last_seen?: string;
    /**
     * The device mac address.
     */
    mac_address?: string;
    /**
     * The device manufacturer name.
     */
    manufacturer?: string;
    /**
     * The device model name.
     */
    model?: string;
    /**
     * The device name.
     */
    name?: string;
    /**
     * The Linux distro name.
     */
    os_distro_name?: string;
    /**
     * The Linux distro revision.
     */
    os_distro_revision?: string;
    /**
     * The operating system version.
     */
    os_version?: string;
    /**
     * The operating system version extra parameter.
     */
    os_version_extra?: string;
    /**
     * When the device was revoked.
     */
    revoked_at?: string;
    /**
     * The device serial number.
     */
    serial_number?: string;
    /**
     * When the device was updated.
     */
    updated?: string;
    user?: Device.User;
    /**
     * The WARP client version.
     */
    version?: string;
}
export declare namespace Device {
    interface User {
        /**
         * UUID
         */
        id?: string;
        /**
         * The contact email address of the user.
         */
        email?: string;
        /**
         * The enrolled device user's name.
         */
        name?: string;
    }
}
export type DeviceGetResponse = unknown | string | null;
export interface DeviceListParams {
    account_id: string;
}
export interface DeviceGetParams {
    account_id: string;
}
export declare namespace Devices {
    export import Device = DevicesAPI.Device;
    export import DeviceGetResponse = DevicesAPI.DeviceGetResponse;
    export import DevicesSinglePage = DevicesAPI.DevicesSinglePage;
    export import DeviceListParams = DevicesAPI.DeviceListParams;
    export import DeviceGetParams = DevicesAPI.DeviceGetParams;
    export import DEXTests = DEXTestsAPI.DEXTests;
    export import DEXTest = DEXTestsAPI.DEXTest;
    export import SchemaData = DEXTestsAPI.SchemaData;
    export import SchemaHTTP = DEXTestsAPI.SchemaHTTP;
    export import DEXTestDeleteResponse = DEXTestsAPI.DEXTestDeleteResponse;
    export import SchemaHTTPSSinglePage = DEXTestsAPI.SchemaHTTPSSinglePage;
    export import DEXTestCreateParams = DEXTestsAPI.DEXTestCreateParams;
    export import DEXTestUpdateParams = DEXTestsAPI.DEXTestUpdateParams;
    export import DEXTestListParams = DEXTestsAPI.DEXTestListParams;
    export import DEXTestDeleteParams = DEXTestsAPI.DEXTestDeleteParams;
    export import DEXTestGetParams = DEXTestsAPI.DEXTestGetParams;
    export import Networks = NetworksAPI.Networks;
    export import DeviceNetwork = NetworksAPI.DeviceNetwork;
    export import NetworkDeleteResponse = NetworksAPI.NetworkDeleteResponse;
    export import DeviceNetworksSinglePage = NetworksAPI.DeviceNetworksSinglePage;
    export import NetworkCreateParams = NetworksAPI.NetworkCreateParams;
    export import NetworkUpdateParams = NetworksAPI.NetworkUpdateParams;
    export import NetworkListParams = NetworksAPI.NetworkListParams;
    export import NetworkDeleteParams = NetworksAPI.NetworkDeleteParams;
    export import NetworkGetParams = NetworksAPI.NetworkGetParams;
    export import Policies = PoliciesAPI.Policies;
    export import SettingsPolicy = PoliciesAPI.SettingsPolicy;
    export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
    export import SettingsPoliciesSinglePage = PoliciesAPI.SettingsPoliciesSinglePage;
    export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
    export import PolicyListParams = PoliciesAPI.PolicyListParams;
    export import PolicyDeleteParams = PoliciesAPI.PolicyDeleteParams;
    export import PolicyEditParams = PoliciesAPI.PolicyEditParams;
    export import PolicyGetParams = PoliciesAPI.PolicyGetParams;
    export import Posture = PostureAPI.Posture;
    export import CarbonblackInput = PostureAPI.CarbonblackInput;
    export import ClientCertificateInput = PostureAPI.ClientCertificateInput;
    export import CrowdstrikeInput = PostureAPI.CrowdstrikeInput;
    export import DeviceInput = PostureAPI.DeviceInput;
    export import DeviceMatch = PostureAPI.DeviceMatch;
    export import DevicePostureRule = PostureAPI.DevicePostureRule;
    export import DiskEncryptionInput = PostureAPI.DiskEncryptionInput;
    export import DomainJoinedInput = PostureAPI.DomainJoinedInput;
    export import FileInput = PostureAPI.FileInput;
    export import FirewallInput = PostureAPI.FirewallInput;
    export import IntuneInput = PostureAPI.IntuneInput;
    export import KolideInput = PostureAPI.KolideInput;
    export import OSVersionInput = PostureAPI.OSVersionInput;
    export import SentineloneInput = PostureAPI.SentineloneInput;
    export import SentineloneS2sInput = PostureAPI.SentineloneS2sInput;
    export import TaniumInput = PostureAPI.TaniumInput;
    export import UniqueClientIDInput = PostureAPI.UniqueClientIDInput;
    export import WorkspaceOneInput = PostureAPI.WorkspaceOneInput;
    export import PostureDeleteResponse = PostureAPI.PostureDeleteResponse;
    export import DevicePostureRulesSinglePage = PostureAPI.DevicePostureRulesSinglePage;
    export import PostureCreateParams = PostureAPI.PostureCreateParams;
    export import PostureUpdateParams = PostureAPI.PostureUpdateParams;
    export import PostureListParams = PostureAPI.PostureListParams;
    export import PostureDeleteParams = PostureAPI.PostureDeleteParams;
    export import PostureGetParams = PostureAPI.PostureGetParams;
    export import Revoke = RevokeAPI.Revoke;
    export import RevokeCreateResponse = RevokeAPI.RevokeCreateResponse;
    export import RevokeCreateParams = RevokeAPI.RevokeCreateParams;
    export import Settings = SettingsAPI.Settings;
    export import DeviceSettings = SettingsAPI.DeviceSettings;
    export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
    export import SettingListParams = SettingsAPI.SettingListParams;
    export import Unrevoke = UnrevokeAPI.Unrevoke;
    export import UnrevokeCreateResponse = UnrevokeAPI.UnrevokeCreateResponse;
    export import UnrevokeCreateParams = UnrevokeAPI.UnrevokeCreateParams;
    export import OverrideCodes = OverrideCodesAPI.OverrideCodes;
    export import OverrideCodeListResponse = OverrideCodesAPI.OverrideCodeListResponse;
    export import OverrideCodeListParams = OverrideCodesAPI.OverrideCodeListParams;
}
//# sourceMappingURL=devices.d.ts.map