Create enrollment tokens for multiple users

POST

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

Create enrollment tokens for multiple users

Required Permission: mdm.windows.enrollmentToken.create

Generate enrollment credentials for multiple users simultaneously, distributing personalized enrollment links and instructions to each specified email address with shared policy settings.

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

Body Params application/json

type string optional

object

children object optional

sendEmail object optional

type string optional

boolean

flags object optional

insensitive boolean optional

presence string optional

required

truthy boolean optional

falsy boolean optional

displayName object optional

type string optional

string

valids string optional

rules object optional

name string optional

max

arg number optional

Format: float

128

tags object optional

type string optional

array

flags object optional

sparse boolean optional

items object optional

type string optional

string

valids string optional

rules object optional

name string optional

max

arg number optional

Format: float

128

duration object optional

type string optional

number

flags object optional

unsafe boolean optional

invalids number optional

Format: float

null

rules object optional

name string optional

integer

language object optional

type string optional

string

flags object optional

allowOnly boolean optional

valids string optional

es

invalids string optional

emailText object optional

type string optional

string

valids string optional

winPolicyId object optional

type string optional

string

valids string optional

rules object optional

name string optional

regex

arg object optional

pattern string optional

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

winPolicyAssignments object optional

type string optional

array

flags object optional

sparse boolean optional

items object optional

type string optional

object

children object optional

winPolicyId object optional

priority object optional

segmentId object optional

type string optional

number

flags object optional

unsafe boolean optional

invalids number optional

Format: float

null

rules object optional

name string optional

integer

userEmails array [string] required

Email address array for bulk token generation creating individual enrollment tokens per address enabling mass provisioning campaigns and streamlined onboarding for large user groups.

{
    "type": "object",
    "children": {
        "sendEmail": {
            "type": "boolean",
            "flags": {
                "insensitive": true,
                "presence": "required"
            },
            "truthy": true,
            "falsy": true
        },
        "displayName": {
            "type": "string",
            "valids": "",
            "rules": {
                "name": "max",
                "arg": 128
            }
        },
        "tags": {
            "type": "array",
            "flags": {
                "sparse": true
            },
            "items": {
                "type": "string",
                "valids": "",
                "rules": {
                    "name": "max",
                    "arg": 128
                }
            }
        },
        "duration": {
            "type": "number",
            "flags": {
                "unsafe": true
            },
            "invalids": null,
            "rules": {
                "name": "integer"
            }
        },
        "language": {
            "type": "string",
            "flags": {
                "allowOnly": true
            },
            "valids": "es",
            "invalids": ""
        },
        "emailText": {
            "type": "string",
            "valids": ""
        },
        "winPolicyId": {
            "type": "string",
            "valids": "",
            "rules": {
                "name": "regex",
                "arg": {
                    "pattern": "string"
                }
            }
        },
        "winPolicyAssignments": {
            "type": "array",
            "flags": {
                "sparse": true
            },
            "items": {
                "type": "object",
                "children": {
                    "winPolicyId": {
                        "type": "string",
                        "invalids": "",
                        "rules": {
                            "name": "regex",
                            "arg": {
                                "pattern": "string"
                            }
                        }
                    },
                    "priority": {
                        "type": "number",
                        "flags": {
                            "unsafe": true,
                            "presence": "required"
                        },
                        "invalids": null,
                        "rules": {
                            "name": "integer"
                        }
                    }
                }
            }
        },
        "segmentId": {
            "type": "number",
            "flags": {
                "unsafe": true
            },
            "invalids": null,
            "rules": {
                "name": "integer"
            }
        }
    },
    "userEmails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ]
}

Responses

200 Response application/json

status boolean optional

data object optional

total number required

Total number of enrollment tokens requested in bulk creation operation for processing tracking and validation.

Format: float

success number required

Count of successfully created enrollment tokens in bulk operation indicating completed provisioning for device distribution.

Format: float

fail number required

Count of failed enrollment token creations in bulk operation requiring investigation for email validation or quota issues.

Format: float

{
    "status": true,
    "data": {
        "total": 10,
        "success": 9,
        "fail": 1
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5145

message string optional

Error creating winEnrollmentToken

{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}

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