Type alias DeviceSchema

DeviceSchema: {
    api_key_last_changed?: string;
    created_by?: string;
    created_date: string;
    custom_attributes: {
        [key: string]: string;
    };
    group_ids?: string[];
    id: string;
    iot_scopes: {
        [key: string]: PubSubPermissions;
    };
    is_delete_protected?: boolean;
    is_group_admin?: boolean;
    is_org_admin?: boolean;
    is_project_admin?: boolean;
    last_seen?: string;
    last_updated_by?: string;
    last_updated_date?: string;
    locale: string;
    mac_address?: string;
    manufacturer?: string;
    mqtt_credentials_last_changed?: string;
    name: string;
    open_tunnels: Tunnel[];
    org_permissions?: OrgAccessPermissions;
    owner_id?: string;
    picture?: string;
    picture_base64?: string;
    picture_content_type?: string;
    product?: string;
    project_id?: string;
    project_ids?: string[];
    project_permissions?: ProjectAccessPermissions;
    restricted_custom_attributes: {
        [key: string]: string;
    };
    role_ids?: string[];
    serial_number?: string;
    site?: string;
    tags: string[];
    zoneinfo: string;
}

Type declaration

  • Optional api_key_last_changed?: string

    UTC datetime the API key was last changed

  • Optional created_by?: string

    ID of the user who created this account

  • created_date: string

    UTC datetime the account was created

  • custom_attributes: {
        [key: string]: string;
    }

    Custom attributes for this device

    • [key: string]: string
  • Optional group_ids?: string[]

    Groups they belong to, individual devices only

  • id: string

    ID of the account

  • iot_scopes: {
        [key: string]: PubSubPermissions;
    }

    PubSub permissions per IoT scope for this device

  • Optional is_delete_protected?: boolean
  • Optional is_group_admin?: boolean

    Whether this user is a group admin, only visible when filtered by group

  • Optional is_org_admin?: boolean
  • Optional is_project_admin?: boolean

    Whether this user is a project admin, only visible in project scope

  • Optional last_seen?: string

    UTC datetime the device was last seen

  • Optional last_updated_by?: string

    ID of the user who last updated this account

  • Optional last_updated_date?: string

    UTC datetime the account was last updated

  • locale: string
  • Optional mac_address?: string
  • Optional manufacturer?: string
  • Optional mqtt_credentials_last_changed?: string

    UTC datetime the MQTT credentials were last changed

  • name: string
  • open_tunnels: Tunnel[]

    List of open tunnels to this device

  • Optional org_permissions?: OrgAccessPermissions

    Organization permissions, only included for individual devices

  • Optional owner_id?: string

    ID of the device owner

  • Optional picture?: string
  • Optional picture_base64?: string
  • Optional picture_content_type?: string
  • Optional product?: string
  • Optional project_id?: string

    ID of the project this group belongs to, if any

  • Optional project_ids?: string[]

    Projects they belong to, individual devices only

  • Optional project_permissions?: ProjectAccessPermissions

    Project permissions, only included for individual devices in project scope

  • restricted_custom_attributes: {
        [key: string]: string;
    }

    Custom attributes only admins can update

    • [key: string]: string
  • Optional role_ids?: string[]

    Roles they belong to, individual devices only

  • Optional serial_number?: string
  • Optional site?: string
  • tags: string[]

    Tags for this device

  • zoneinfo: string

Settings

Member Visibility

Theme