Type alias CreateDeviceBody

CreateDeviceBody: {
    custom_attributes?: {
        [key: string]: string;
    };
    iot_scopes?: {
        [key: string]: PubSubPermissions;
    };
    is_active?: boolean;
    is_delete_protected?: boolean;
    locale?: string;
    mac_address?: string;
    manufacturer?: string;
    name: string;
    org_permissions?: OrgAccessPermissions;
    owner_id?: string;
    picture?: string;
    product?: string;
    project_id?: string;
    project_permissions?: ProjectAccessPermissions;
    restricted_custom_attributes?: {
        [key: string]: string;
    };
    serial_number?: string;
    site?: string;
    tags?: string[];
    zoneinfo?: string;
}

Type declaration

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

    Custom attributes for this user

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

    PubSub permissions per IoT scope for this device

  • Optional is_active?: boolean

    (Admin only) Whether this account is active

  • Optional is_delete_protected?: boolean

    Whether this account is delete protected

  • Optional locale?: string

    Locale of the account

  • Optional mac_address?: string

    MAC address of this device

  • Optional manufacturer?: string

    Device manufacturer

  • name: string

    Name of the device

  • Optional org_permissions?: OrgAccessPermissions

    Organization permissions

  • Optional owner_id?: string

    ID of the device owner

  • Optional picture?: string

    URL of the account's picture

  • Optional product?: string

    Product name

  • Optional project_id?: string

    ID of project to create them in (org admins only)

  • Optional project_permissions?: ProjectAccessPermissions

    Project permissions

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

    Custom attributes only admins can update

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

    Device serial number

  • Optional site?: string

    Location of this device

  • Optional tags?: string[]

    List of tags on this account

  • Optional zoneinfo?: string

    Timezone of the account

Settings

Member Visibility

Theme