Get list of winEnrollmentToken

GET

/v1/organizations/:organizationId/mdm/windows/enterprise/enrollment-tokens/

Get list of winEnrollmentToken

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

win-policy string

optional

Entity Id

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

show-deleted boolean

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

organizationId string optional

Entity Id

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

winEnterpriseId string optional

Entity Id

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

winDeviceId string optional

Entity Id

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

mdmUser object optional

id string optional

Entity Id

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

email string optional

≤ 128 characters

displayName string optional

≤ 128 characters

tags array [string] optional

state string optional

PENDING DONE DELETED EXPIRED

config object optional

type string optional

≤ 128 characters

subType string optional

≤ 128 characters

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

expireAt string optional

Format: date-time

enrollmentLink string optional

≤ 500 characters

enrollCode string optional

≤ 128 characters

winPolicyId string optional

Entity Id

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

winPolicyAssignments array [object] optional

winPolicyId string optional

Entity Id

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

winPolicy object optional

id string optional

Entity Id

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

organizationId string optional

Entity Id

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

winEnterpriseId string optional

Entity Id

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

name string optional

≤ 256 characters

config object optional

applications array [object] optional

applicationsInfo array [object] optional

scripts array [object] optional

scriptsInfo array [object] optional

admxConfigs array [object] optional

admxConfigsInfo array [object] optional

agentConfiguration object optional

assets array [object] optional

assetsInfo array [object] optional

version integer optional

≥ 0

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

priority integer optional

≥ 0

summary object optional

expirationTimestamp string optional

Format: date-time

sendEmail boolean optional

emailText string optional

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",
                "organizationId": "string",
                "winEnterpriseId": "string",
                "winDeviceId": "string",
                "mdmUser": {
                    "id": "string",
                    "email": "string"
                },
                "displayName": "string",
                "tags": [
                    "string"
                ],
                "state": "PENDING",
                "config": {},
                "type": "string",
                "subType": "string",
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z",
                "expireAt": "2024-01-01T00: 00:00Z",
                "enrollmentLink": "string",
                "enrollCode": "string",
                "winPolicyId": "string",
                "winPolicyAssignments": [
                    {
                        "winPolicyId": "string",
                        "winPolicy": {
                            "id": "string",
                            "organizationId": "string",
                            "winEnterpriseId": "string",
                            "name": "string",
                            "config": {},
                            "applications": [
                                {
                                    "winApplicationId": "string",
                                    "configuration": {},
                                    "action": "forceInstall"
                                }
                            ],
                            "applicationsInfo": [
                                {}
                            ],
                            "scripts": [
                                {
                                    "type": "once",
                                    "id": "string",
                                    "loopTime": 0,
                                    "resetDate": "2024-01-01T00: 00:00Z",
                                    "arguments": "string",
                                    "argumentsProcessed": "string",
                                    "name": "string",
                                    "description": "string",
                                    "runner": "string"
                                }
                            ],
                            "scriptsInfo": [
                                {}
                            ],
                            "admxConfigs": [
                                {
                                    "winAdmxConfigId": "string"
                                }
                            ],
                            "admxConfigsInfo": [
                                {
                                    "id": "string",
                                    "appName": "string",
                                    "settingType": "string",
                                    "fileName": "string",
                                    "description": "string"
                                }
                            ],
                            "agentConfiguration": {
                                "enabled": true,
                                "buildTag": "string",
                                "allowLocation": true,
                                "allowNetworkStatus": true,
                                "allowPackageTime": true,
                                "allowPackageTransfer": true
                            },
                            "assets": [
                                {
                                    "mdmAssetId": "string",
                                    "location": "string",
                                    "assetName": "string",
                                    "scope": "user"
                                }
                            ],
                            "assetsInfo": [
                                {}
                            ],
                            "version": 0,
                            "updatedAt": "2024-01-01T00: 00:00Z",
                            "createdAt": "2024-01-01T00: 00:00Z"
                        },
                        "priority": 0
                    }
                ],
                "summary": {
                    "expirationTimestamp": "2024-01-01T00: 00:00Z"
                },
                "sendEmail": true,
                "emailText": "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"
    }
}