Create direct provisioning item

POST

/v1/organizations/:organizationId/mdm/android/enterprise/enrollment-templates/:emmEnrollmentTemplateId/direct-provisioning/

Create direct provisioning item

Required Permission: mdm.android.directProvisioning.create

Creates a new direct provisioning item associated with a specific Android Enterprise enrollment template.

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

emmEnrollmentTemplateId string

required

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

Body Params application/json

name string required

≤ 128 characters

mdmUserId string required

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

auxiliaryFields array [object] optional

key string required

≤ 128 characters

value string required

{
    "name": "string",
    "mdmUserId": "string",
    "auxiliaryFields": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

Responses

200 Response application/json

status boolean required

data object required

id string required

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

emmEnrollmentTemplateId string required

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

enrollmentTokenId string required

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

name string optional

≤ 128 characters

mdmUserId string optional

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

auxiliaryFields array [object] optional

key string required

≤ 128 characters

value string required

mdmUser object optional

id string required

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

email string required

≤ 128 characters

enrollmentToken object required

id string required

Unique enrollment token identifier used to track Android Enterprise device enrollment credentials throughout lifecycle.

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

organization string optional

Organization identifier owning this enrollment token and managing enrolled Android Enterprise devices under EMM policy.

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

emmEnterprise string optional

Android Enterprise (EMM) enterprise account identifier linked to Google Managed Play for device and app management.

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

emmPolicyAssignments array [object] optional

Ordered list of Android Enterprise policy assignments applied to devices enrolling with this token prioritized by sequence.

emmPolicyId string optional

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

emmPolicy any optional

priority integer optional

≥ 0 · ≤ 9007199254740991

mdmUser object optional

MDM user account information associated with enrollment token including identifier and email for device ownership tracking.

id string optional

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

email string optional

≤ 128 characters

emmDevice string optional

Android Enterprise device identifier created after successful enrollment using this token for device lifecycle tracking.

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

displayName any optional

Human-readable enrollment token name displayed in dashboard for administrative identification and organizational purposes throughout device lifecycle.

tags array optional

Custom classification labels for enrollment token organization enabling filtering, grouping, and policy automation across device fleet.

status string optional

Current enrollment token lifecycle state indicating availability for device enrollment or completion status tracking.

PENDING DONE DELETED EXPIRED

sendEmail boolean optional

Flag controlling whether enrollment instructions and QR code are automatically sent to MDM user email address.

managementMode string optional

Android Enterprise management mode defining device ownership and control level applied during enrollment process execution.

DEVICE_OWNER PROFILE_OWNER COPE USERLESS

emailText any optional

Custom message content appended to enrollment notification email for user-specific instructions or organizational policy communication.

config object optional

Technical enrollment configuration containing Google Cloud generated credentials and expiration settings for device provisioning.

expirationTimestamp string optional

≤ 128 characters

code string optional

≤ 128 characters

_config any optional

Internal configuration data restricted to administrator access level containing sensitive enrollment credentials and system metadata.

summary object optional

Enrollment token overview containing human-readable management mode description and expiration information for dashboard display.

managementMode string optional

DEVICE_OWNER PROFILE_OWNER COPE USERLESS

expirationTimestamp string optional

≤ 128 characters

type string optional

Enrollment token type classifier indicating platform-specific enrollment method used for cross-platform MDM management dashboards.

≤ 128 characters

subType string optional

Enrollment token sub-classification providing additional context for specialized enrollment scenarios within Android Enterprise management.

≤ 128 characters

state string optional

Legacy enrollment token state field maintained for backward compatibility with previous API versions tracking lifecycle.

PENDING DONE DELETED EXPIRED

perpetual boolean optional

Flag indicating whether enrollment token has unlimited validity or follows standard expiration policy for continuous enrollment.

qrcodeUrl string optional

URL to downloadable QR code image embeddin enrollment credentials for Android device camera-based provisioning workflow.

enrollmentLink string optional

Deep link URL for Android enrollment initiation allowing web-based device provisioning without QR code scanning.

≤ 256 characters

createdAt string optional

ISO timestamp when enrollment token was created in system for audit tracking and lifecycle management purposes.

updatedAt string optional

ISO timestamp of last enrollment token modification for change tracking and synchronization across distributed systems.

segmentId integer optional

Segment identifier for scoping enrollment token into an specific segment

≥ 0 · ≤ 9007199254740991

validRule object optional

name any optional

displayNamePattern any optional

tags array optional

conditions array [object] optional

tags array [array] optional

auxiliaryFields array [array] optional

patterns array optional

identifiers array optional

emmPolicyId string optional

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

emmPolicyAssignments array [object] optional

emmPolicyId string required

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

priority integer required

≥ 0 · ≤ 10000

segmentId integer optional

≥ 0 · ≤ 9007199254740991

createdAt string required

updatedAt string required

{
    "status": true,
    "data": {
        "id": "string",
        "emmEnrollmentTemplateId": "string",
        "enrollmentTokenId": "string",
        "name": "string",
        "mdmUserId": "string",
        "auxiliaryFields": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "mdmUser": {
            "id": "string",
            "email": "string"
        },
        "enrollmentToken": {
            "id": "string",
            "organization": "string",
            "emmEnterprise": "string",
            "emmPolicyAssignments": [
                {
                    "emmPolicyId": "string",
                    "emmPolicy": "string",
                    "priority": 0
                }
            ],
            "mdmUser": {
                "id": "string",
                "email": "string"
            },
            "emmDevice": "string",
            "displayName": "string",
            "tags": [
                "string"
            ],
            "status": "PENDING",
            "sendEmail": true,
            "managementMode": "DEVICE_OWNER",
            "emailText": "string",
            "config": {
                "expirationTimestamp": "string",
                "code": "string"
            },
            "_config": "string",
            "summary": {
                "managementMode": "DEVICE_OWNER",
                "expirationTimestamp": "string"
            },
            "type": "string",
            "subType": "string",
            "state": "PENDING",
            "perpetual": true,
            "qrcodeUrl": "string",
            "enrollmentLink": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "segmentId": 0
        },
        "validRule": {
            "name": "string",
            "displayNamePattern": "string",
            "tags": [
                "string"
            ],
            "conditions": [
                {
                    "tags": [
                        [
                            "string"
                        ]
                    ],
                    "auxiliaryFields": [
                        [
                            "string"
                        ]
                    ],
                    "patterns": [
                        "string"
                    ],
                    "identifiers": [
                        "string"
                    ]
                }
            ],
            "emmPolicyId": "string",
            "emmPolicyAssignments": [
                {
                    "emmPolicyId": "string",
                    "priority": 0
                }
            ],
            "segmentId": 0
        },
        "createdAt": "string",
        "updatedAt": "string"
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5168

message string optional

Required auxiliaryFields invalid

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