Get admDepDevice by Id or Slug

GET

/v1/organizations/:organizationId/mdm/apple/enterprise/dep/devices/:admDepDeviceId

Get admDepDevice by Id or Slug

Required Permission: mdm.apple.depDevice.get

Get admDepDevice by Id or Slug

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

admDepDeviceId string

required

Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json

status boolean optional

data object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

organization string optional

Match pattern: ^[a-fA-F0-9]{24}$

admEnterprise string optional

Match pattern: ^[a-fA-F0-9]{24}$

serialNumber string optional

≤ 256 characters

assetTag string optional

≤ 256 characters

description string optional

≤ 256 characters

deviceModel string optional

≤ 256 characters

color string optional

≤ 256 characters

os string optional

iOS OSX tvOS

profile object optional

uuid string optional

≤ 256 characters

assignTime string optional

Format: date-time

pushTime string optional

Format: date-time

status string optional

assigned pushed removed

device object optional

assignedBy string optional

≤ 256 characters

assignedDate string optional

Format: date-time

family string optional

≤ 256 characters

op object optional

type string optional

added modified deleted

date string optional

Format: date-time

admDepProfileId string optional

Match pattern: ^[a-fA-F0-9]{24}$

admDepProfileInfo object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

profileName string optional

≤ 256 characters

admEnrollmentTemplateId string optional

Match pattern: ^[a-fA-F0-9]{24}$

admEnrollmentTemplateInfo object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

≤ 256 characters

segmentId integer optional

≥ 0

config object optional

admPolicyId string optional

Match pattern: ^[a-fA-F0-9]{24}$

admPolicyAssignments array [object] optional

admPolicyId string optional

Match pattern: ^[a-fA-F0-9]{24}$

priority integer required

≥ 0 · ≤ 10000

admVppLocationId string optional

Match pattern: ^[a-fA-F0-9]{24}$

mdmUserId string optional

Match pattern: ^[a-fA-F0-9]{24}$

commands array [object] optional

displayNamePattern string optional

≤ 256 characters

setDeviceName boolean optional

tags array [string] optional

allowActivationLock boolean optional

setupAssistantEnable boolean optional

setupAssistantSkippable boolean optional

ssoInfo object optional

email string optional

≤ 256 characters · Format: email

firstName string optional

≤ 256 characters

lastName string optional

≤ 256 characters

userName string optional

≤ 256 characters

tags array [string] optional

skipPersonalInfo boolean optional

segmentId integer optional

≥ 0

version integer optional

≥ 0

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

admDevice object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

enrolledDate string optional

Format: date-time

state string optional

PROVISIONING ACTIVE DELETED UNKNOWN EXPIRED PENDING

{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "admEnterprise": "string",
        "serialNumber": "string",
        "assetTag": "string",
        "description": "string",
        "deviceModel": "string",
        "color": "string",
        "os": "iOS",
        "profile": {
            "uuid": "string",
            "assignTime": "2024-01-01T00: 00:00Z",
            "pushTime": "2024-01-01T00: 00:00Z",
            "status": ""
        },
        "device": {
            "assignedBy": "string",
            "assignedDate": "2024-01-01T00: 00:00Z",
            "family": "string"
        },
        "op": {
            "type": "added",
            "date": "2024-01-01T00: 00:00Z"
        },
        "admDepProfileId": "string",
        "admDepProfileInfo": {
            "id": "string",
            "profileName": "string"
        },
        "admEnrollmentTemplateId": "string",
        "admEnrollmentTemplateInfo": {
            "id": "string",
            "name": "string",
            "segmentId": 0
        },
        "config": {
            "admPolicyId": "string",
            "admPolicyAssignments": [
                {
                    "admPolicyId": "string",
                    "priority": 0
                }
            ],
            "admVppLocationId": "string",
            "mdmUserId": "string",
            "commands": [
                {}
            ],
            "displayNamePattern": "string",
            "setDeviceName": true,
            "tags": [
                "string"
            ],
            "allowActivationLock": true,
            "setupAssistantEnable": true,
            "setupAssistantSkippable": true,
            "ssoInfo": {
                "email": "[email protected]",
                "firstName": "string",
                "lastName": "string",
                "userName": "string",
                "tags": [
                    "string"
                ]
            },
            "skipPersonalInfo": true,
            "segmentId": 0
        },
        "version": 0,
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "admDevice": {
            "id": "string",
            "enrolledDate": "2024-01-01T00: 00:00Z",
            "state": "PROVISIONING"
        }
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}