Get list of emmEnrollmentToken

GET /v1/organizations/:organizationId/mdm/android/enterprise/enrollment-tokens/

Get list of emmEnrollmentToken

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Entity Id or Slug

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

page integer

optional

Page number

limit integer

optional

Number of elements by page

sort string

optional

Match pattern: ^[\w.]*((:asc)|(:desc))?$

mdm-user string

optional

Entity Id

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

status array

optional

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

id string optional

Entity Id

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

organization string optional

Entity Id

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

emmEnterprise string optional

Entity Id

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

emmPolicyAssignments array [object] optional

emmPolicyId string optional

Entity Id

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

emmPolicy object optional

id string optional

Entity Id

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

name string optional

≤ 128 characters

description string optional

≤ 256 characters

version string optional

≤ 128 characters

config object optional

_config object optional

packages object optional

emmEnterprise string optional

Entity Id

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

private boolean optional

assets array [object] optional

assetsInfo array [object] optional

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

agentConfiguration object optional

kioskLauncherConfiguration object optional

certificateProviderIds array [string] optional

applications array [object] optional

applicationsInfo array [object] optional

priority integer optional

≥ 0

mdmUser object optional

id string optional

Entity Id

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

email string optional

≤ 128 characters

emmDevice string optional

Entity Id

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

displayName string optional

≤ 128 characters

tags array [string] optional

status string optional

PENDING DONE DELETED EXPIRED

sendEmail boolean optional

managementMode string optional

DEVICE_OWNER PROFILE_OWNER COPE USERLESS

emailText string optional

config object optional

expirationTimestamp string optional

Format: date-time

code string optional

≤ 128 characters

_config object optional

Only available for platform admin users

summary object optional

managementMode string optional

≤ 128 characters

expirationTimestamp string optional

Format: date-time

type string optional

≤ 128 characters

subType string optional

≤ 128 characters

state string optional

PENDING DONE DELETED EXPIRED

perpetual boolean optional

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

qrcodeUrl string optional

enrollmentLink string optional

≤ 256 characters

totalDocs integer optional

limit integer optional

hasPrevPage boolean optional

hasNextPage boolean optional

page integer optional

totalPages integer optional

prevPage integer optional

nextPage integer optional

lean boolean optional

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organization": "string",
                "emmEnterprise": "string",
                "emmPolicyAssignments": [
                    {
                        "emmPolicyId": "string",
                        "emmPolicy": {
                            "id": "string",
                            "name": "string",
                            "description": "string",
                            "version": "string",
                            "config": {},
                            "_config": {},
                            "packages": {},
                            "emmEnterprise": "string",
                            "private": true,
                            "assets": [
                                {
                                    "mdmAssetId": "string",
                                    "location": "string",
                                    "assetName": "string",
                                    "scope": "user"
                                }
                            ],
                            "assetsInfo": [
                                {}
                            ],
                            "updatedAt": "2024-01-01T00: 00:00Z",
                            "createdAt": "2024-01-01T00: 00:00Z",
                            "agentConfiguration": {
                                "allowLocation": true,
                                "allowPackageTime": true,
                                "allowPackageTransfer": true,
                                "allowNetworkStatus": true
                            },
                            "kioskLauncherConfiguration": {
                                "displayDeviceName": true,
                                "settingAction": "string",
                                "whitelistedApps": [
                                    "string"
                                ],
                                "escapeHatchPassword": "string",
                                "backgroundUrl": "string",
                                "iconSize": "string",
                                "screenAlwaysOn": true,
                                "unlockPassword": "string",
                                "inactivityLockTime": 0,
                                "startingUpApps": [
                                    {
                                        "packageName": "string",
                                        "config": {}
                                    }
                                ],
                                "appsLayout": [
                                    {
                                        "type": "app",
                                        "package": "string"
                                    }
                                ],
                                "header": {
                                    "text": "string",
                                    "fontSize": "small"
                                },
                                "footer": {
                                    "text": "string",
                                    "fontSize": "small"
                                }
                            },
                            "certificateProviderIds": [
                                "string"
                            ],
                            "applications": [
                                {
                                    "emmApplicationId": "string",
                                    "configuration": "string",
                                    "action": "forceInstall",
                                    "updatePolicy": {},
                                    "customAppConfig": {}
                                }
                            ],
                            "applicationsInfo": [
                                {
                                    "emmApplicationId": "string",
                                    "emmApplication": {}
                                }
                            ]
                        },
                        "priority": 0
                    }
                ],
                "mdmUser": {
                    "id": "string",
                    "email": "string"
                },
                "emmDevice": "string",
                "displayName": "string",
                "tags": [
                    "string"
                ],
                "status": "PENDING",
                "sendEmail": true,
                "managementMode": "DEVICE_OWNER",
                "emailText": "string",
                "config": {
                    "expirationTimestamp": "2024-01-01T00: 00:00Z",
                    "code": "string"
                },
                "_config": {},
                "summary": {
                    "managementMode": "string",
                    "expirationTimestamp": "2024-01-01T00: 00:00Z"
                },
                "type": "string",
                "subType": "string",
                "state": "PENDING",
                "perpetual": true,
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z",
                "qrcodeUrl": "string",
                "enrollmentLink": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}

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"
    }
}