Skip to main content
Module

x/jamf_school/mod.ts>Profile

A simple, secure, correct, and modern Jamf School API wrapper. (Unofficial)
SeparateRecords/deno_jamf_school
Latest
interface Profile
Re-export
import { type Profile } from "https://deno.land/x/jamf_school@0.5.0/mod.ts";

Profile represents a single profile.

The API does not provide any ways to edit the data on a profile.

Properties

readonly
type: "Profile"

Discriminator for type checks.

readonly
id: number

The ID of the profile.

readonly
locationId: number

The ID of this profile's location.

readonly
identifier: string

The identifier used when installing the profile.

readonly
name: string

The name of the profile.

readonly
description: string

The description of the device.

readonly
isUniversal: boolean

Whether the profile can be installed on any device, regardless of OS.

readonly
platform: { readonly iOS: boolean; readonly macOS: boolean; readonly tvOS: boolean; }

The platforms this profile can be installed on.

Jamf School allows for iOS, macOS, tvOS and "custom" (universal) profiles. OS-specific profiles will only set their OS property to true. Universal profiles set every property to true, but note that this doesn't mean that they will successfully install on each platform.

readonly
isScheduled: boolean

Whether the profile has a time filter.

Methods

toJSON(): unknown

Return the data used to create this object.

toString(): string

The name of the profile.

update(): Promise<void>

(Read) Update this profile's data.

Other profiles created from the same data will not be updated.

getLocation(): Promise<Location | null>

(Read) Get the location this profile belongs to.

getSchedule(): ProfileSchedule | null

Get the profile's time filter (null if isScheduled is false).