Create new MDM user account

POST

/v1/organizations/:organizationId/mdm/users/

Create new MDM user account

Required Permission: mdm.global.mdmUser.create

Create new device management user account with contact information, tags, and language preferences for enrollment and device assignments.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Organization identifier or URL-friendly slug for scoping user operations within specific workspace and access control boundaries.

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

Body Params application/json

email string required

Primary contact address for device user utilized for enrollment notifications, account identification, and administrative communications.

≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email

name string optional

Display name for device management user shown in administrative interfaces and reports for identification and personalization purposes.

≤ 256 characters

managedAppleId string optional

Managed Apple ID email address linked to this user for Apple Business Manager integration and app license distribution.

≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email

tags array optional

Organizational labels assigned to user for categorization, filtering, and grouping in listings and automation rule targeting.

language string optional

Preferred language code for user controlling interface localization, email communications, and notification content throughout platform.

es en fr de it zh pt ru

metadata object optional

Custom key-value pairs storing additional user information for integration purposes, reporting needs, or organizational specific requirements.

{
    "email": "[email protected]",
    "name": "string",
    "managedAppleId": "[email protected]",
    "tags": [
        "string"
    ],
    "language": "es",
    "metadata": {}
}

Responses

200 Response application/json

status boolean required

data object required

id string required

Unique identifier for device management user enabling targeted operations and tracking across all platform endpoints and administrative interfaces.

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

email string required

Primary contact address for device user utilized for enrollment notifications, account identification, and administrative communications.

≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email

name string required

Display name for device management user shown in administrative interfaces and reports for identification and personalization purposes.

≤ 256 characters

tags array required

Organizational labels assigned to user for categorization, filtering, and grouping in listings and automation rule targeting.

android object required

Android platform statistics aggregating device counts and enrollment token status for Android Enterprise management visibility and analytics.

devices object required

Device count distribution by Android Enterprise management mode showing organizational control model breakdown.

MANAGEMENT_MODE_UNSPECIFIED integer required

Count of Android devices with unspecified management mode representing devices awaiting configuration or in transition states.

≥ 0 · ≤ 9007199254740991

DEVICE_OWNER integer required

Count of fully managed Android devices under complete organizational control enabling comprehensive policy enforcement and security controls.

≥ 0 · ≤ 9007199254740991

PROFILE_OWNER integer required

Count of work profile managed Android devices separating personal and work data with limited organizational control scope.

≥ 0 · ≤ 9007199254740991

enrollmentTokens object required

Enrollment token count distribution categorized by lifecycle status tracking Android device provisioning and registration completion.

DONE integer required

Count of Android enrollment tokens successfully utilized for device enrollment indicating completed registration and activation processes.

≥ 0 · ≤ 9007199254740991

PENDING integer required

Count of Android enrollment tokens awaiting device registration indicating tokens sent but not yet activated by users.

≥ 0 · ≤ 9007199254740991

EXPIRED integer required

Count of Android enrollment tokens that exceeded validity period without usage requiring regeneration for device enrollment attempts.

≥ 0 · ≤ 9007199254740991

DELETED integer required

Count of Android enrollment tokens manually removed or revoked by administrators preventing further device registration with them.

≥ 0 · ≤ 9007199254740991

apple object required

Apple platform statistics showing enrolled device count and active enrollment profile assignments for iOS, iPadOS, and macOS management.

devices integer required

Total count of Apple devices enrolled under this user across iOS, iPadOS, and macOS platforms for inventory tracking.

≥ 0 · ≤ 9007199254740991

enrollmentTokens integer required

≥ 0 · ≤ 9007199254740991

windows object required

Windows platform statistics displaying enrolled device count and available enrollment tokens for Windows desktop management operations.

devices integer required

Total count of Windows devices enrolled and managed under this user for desktop and laptop inventory tracking purposes.

≥ 0 · ≤ 9007199254740991

enrollmentTokens integer required

Count of active Windows enrollment tokens assigned to this user enabling device registration and policy application processes.

≥ 0 · ≤ 9007199254740991

language string required

Preferred language code for user controlling interface localization, email communications, and notification content throughout platform.

es en fr de it zh pt ru

managedAppleId string optional

Managed Apple ID email address linked to this user for Apple Business Manager integration and app license distribution.

≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email

metadata object required

Custom key-value pairs storing additional user information for integration purposes, reporting needs, or organizational specific requirements.

inferredSegmentIds array [number] required

List of segment where the user in included

createdAt string required

ISO 8601 timestamp indicating when user account was initially created providing historical context and analytics for user lifecycle tracking.

updatedAt string required

ISO 8601 timestamp indicating when user record was most recently modified useful for tracking changes, synchronization, and audit trail.

{
    "status": true,
    "data": {
        "id": "string",
        "email": "[email protected]",
        "name": "string",
        "tags": [
            "string"
        ],
        "android": {
            "devices": {
                "MANAGEMENT_MODE_UNSPECIFIED": 0,
                "DEVICE_OWNER": 0,
                "PROFILE_OWNER": 0
            },
            "enrollmentTokens": {
                "DONE": 0,
                "PENDING": 0,
                "EXPIRED": 0,
                "DELETED": 0
            }
        },
        "apple": {
            "devices": 0,
            "enrollmentTokens": 0
        },
        "windows": {
            "devices": 0,
            "enrollmentTokens": 0
        },
        "language": "es",
        "managedAppleId": "[email protected]",
        "metadata": {},
        "inferredSegmentIds": [
            0
        ],
        "createdAt": "string",
        "updatedAt": "string"
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5050

message string optional

Feature not allowed for you billing plan

{
    "status": false,
    "error": {
        "code": 5048,
        "message": "Mdm user already exists"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4001

message string optional

Unauthorized

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