Depot mdmenrollments

Registers the enrollment routes.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

GET /api/v1/endpoints/{agentID}/mdm

GETmdm:readtenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

getEndpointMdm returns an endpoint’s device management summary: its device class, whether it runs the agent, its ownership, its open enrollment, the open Sync now, the commands still in flight and lost mode.

Parameters

Name	In	Type	Required	Description
agentID	path	string	Yes	A uuid.

Responses

Status	Body	Description
200	application/json, EndpointMdmView	Success.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold mdm:read.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	No client context in request.

200 response body

Field	Type	Description
deviceClassrequired	string
enrollment	MdmEnrollmentView	mdmEnrollmentView is the wire MdmEnrollment (contract 7.3).
enrollment.agentIdrequired	string
enrollment.enrolledAt	string (date-time) or null
enrollment.enrolledByNamedUserId	string or null
enrollment.enrollmentTyperequired	string
enrollment.lastCheckInAt	string (date-time) or null
enrollment.lastStatusReportAt	string (date-time) or null
enrollment.ownershiprequired	string
enrollment.providerrequired	string
enrollment.publicIdrequired	string
enrollment.pushTokenStalerequired	boolean
enrollment.serialNumber	string or null
enrollment.staterequired	string
enrollment.supervisedrequired	boolean
enrollment.unenrollReason	string or null
enrollment.unenrolledAt	string (date-time) or null
hasAgentrequired	boolean
lastLocate	Location	Location is a device's reported position, sealed as JSON on the session.
lastLocate.accuracyMetersrequired	number	double.
lastLocate.atrequired	string (date-time)
lastLocate.latrequired	number	double.
lastLocate.lonrequired	number	double.
lostMode	LostModeView	lostModeView is the wire LostMode (contract 7.3) for EndpointMdm.lostMode.
lostMode.disabledAt	string (date-time) or null
lostMode.enabledAtrequired	string (date-time)
lostMode.footnote	string or null
lostMode.lastLocation	Location	Location is a device's reported position, sealed as JSON on the session.
lostMode.lastLocation.accuracyMetersrequired	number	double.
lostMode.lastLocation.atrequired	string (date-time)
lostMode.lastLocation.latrequired	number	double.
lostMode.lastLocation.lonrequired	number	double.
lostMode.message	string or null
lostMode.phone	string or null
lostMode.publicIdrequired	string
lostMode.staterequired	string
lostMode.ticketId	string or null
openSync	MdmSyncView	mdmSyncView is the wire MdmSync (contract 7.3).
openSync.confirmedAt	string (date-time) or null
openSync.expiresAtrequired	string (date-time)
openSync.publicIdrequired	string
openSync.pushedAt	string (date-time) or null
openSync.reasonCode	string or null
openSync.requestedAtrequired	string (date-time)
openSync.staterequired	string
ownershiprequired	string
pendingCommandsrequired	integer
updateOsNowRefusal	string or null

Request samples

curl

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/endpoints/<agentID>/mdm' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

PowerShell

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/endpoints/<agentID>/mdm' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/endpoints/<agentID>/mdm"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

Go

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/endpoints/<agentID>/mdm", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/endpoints/<agentID>/mdm";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/endpoints/<agentID>/mdm");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET /api/v1/mdm/enrollments

GETmdm:readtenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

listMdmEnrollments lists device management enrollments, open ones unless state says otherwise.

Parameters

Name	In	Type	Required	Description
agentId	query	string	No
ownership	query	string	No
page	query	integer	No	One-based page number. Defaults to 1.
pageSize	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
provider	query	string, one of android, apple, fake, windows	No	Comma-separated set. An unrecognised value is refused.
state	query	string, one of active, failed, held, pending, unenrolled, unenrolling	No	Comma-separated set. An unrecognised value is refused.

Responses

Status	Body	Description
200	application/json, PagedResultMdmEnrollmentView	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold mdm:read.
500	application/problem+json, ProblemDetails	No client context in request.

200 response body

Field	Type	Description
itemsrequired	array of MdmEnrollmentView
items[].agentIdrequired	string
items[].enrolledAt	string (date-time) or null
items[].enrolledByNamedUserId	string or null
items[].enrollmentTyperequired	string
items[].lastCheckInAt	string (date-time) or null
items[].lastStatusReportAt	string (date-time) or null
items[].ownershiprequired	string
items[].providerrequired	string
items[].publicIdrequired	string
items[].pushTokenStalerequired	boolean
items[].serialNumber	string or null
items[].staterequired	string
items[].supervisedrequired	boolean
items[].unenrollReason	string or null
items[].unenrolledAt	string (date-time) or null
pagerequired	integer
pageSizerequired	integer
totalrequired	integer

Request samples

curl

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/mdm/enrollments?agentId=<agentId>&ownership=<ownership>&page=0&pageSize=0&provider=android&state=active' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

PowerShell

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/mdm/enrollments?agentId=<agentId>&ownership=<ownership>&page=0&pageSize=0&provider=android&state=active' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/mdm/enrollments"
params = {
    "agentId": "<agentId>",
    "ownership": "<ownership>",
    "page": "0",
    "pageSize": "0",
    "provider": "android",
    "state": "active",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

Go

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/mdm/enrollments?agentId=<agentId>&ownership=<ownership>&page=0&pageSize=0&provider=android&state=active", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = new URL("https://depot.example.com/api/v1/mdm/enrollments");
url.searchParams.set("agentId", "<agentId>");
url.searchParams.set("ownership", "<ownership>");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("provider", "android");
url.searchParams.set("state", "active");

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/mdm/enrollments?agentId=<agentId>&ownership=<ownership>&page=0&pageSize=0&provider=android&state=active");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());