APIUserData | /api.ts | jamf_school@0.5.0

interface APIUserData

import { type APIUserData } from "https://deno.land/x/jamf_school@0.5.0/api.ts";

Properties

optional

username: string

The user's username. This must be unique.

optional

password: string

The password used to sign in to the Jamf School account.

optional

storePassword: boolean

Whether or not to store the password.

optional

domain: string

The LDAP domain the user is in.

optional

email: string

User's email address. This must be unique.

optional

firstName: string

User's first name.

optional

lastName: string

User's surname.

optional

memberOf: (string | number)[]

A list of user group names or IDs the user will belong to. If the name doesn't belong to an existing group, a group with that name will be created.

optional

teacher: number[]

A list of user groups that this user can manage in the Jamf Teacher app.

optional

children: number[]

A list of users that this user can manage in the Jamf Parent app.

optional

notes: string

Other information associated with the user.

optional

exclude: boolean

Whether the user should be excluded from restrictions applied by a teacher.