Favicon

You are here: Home > API Reference > Android > Emmenrollmenttemplates > Retrieve enrollment template details

GET /organizations/:organizationId/mdm/android/enterprise/enrollment-templates/:emmEnrollmentTemplateId

Required Permission: mdm.android.enrollmentTemplate.get

Retrieves detailed configuration, policies, and application information for a specific enrollment template.

GET
/v1/organizations/:organizationId/mdm/android/enterprise/enrollment-templates/:emmEnrollmentTemplateId
Copy to clipboard

Retrieve enrollment template details

Required Permission: mdm.android.enrollmentTemplate.get

Retrieves detailed configuration, policies, and application information for a specific 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
Unique identifier for Android enrollment template configuration within organizational EMM deployment.
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean required
data object required
id string required
Unique identifier for Android enrollment template configuration within organizational EMM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
name string required
Human-readable enrollment template name identifying configuration purpose for Android device onboarding workflows.
≤ 128 characters
description any optional
Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
emmEnrollmentTokenId string optional
Android Enterprise enrollment token identifier linking template to Google Play managed configuration.
Match pattern: ^[a-fA-F0-9]{24}$
emmEnrollmentToken object optional
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
emmPolicyId string optional
Android Enterprise policy identifier defining device restrictions and security settings for enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
emmPolicy object optional
id string optional
Unique Android Enterprise policy identifier used to track configuration rules and security settings throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 128 characters
description string optional
Detailed policy description explaining configuration purpose business requirements and device restrictions for documentation purposes.
≤ 256 characters
version string optional
Policy version identifier synchronized with Google Android Enterprise policy version for change tracking purposes.
≤ 128 characters
config object optional
Google Android Enterprise policy configuration object containing device restrictions security settings and compliance rules.
_config object optional
Internal configuration data restricted to administrator access level containing sensitive policy credentials and system metadata.
packages object optional
Application package information mapping containing installed app details versions and configuration for reporting purposes.
emmEnterprise string optional
Android Enterprise (EMM) account identifier linked to Google Managed Play for device and application management.
Match pattern: ^[a-fA-F0-9]{24}$
private boolean optional
Flag indicating whether policy is private to organization or shared across enterprise for template purposes.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed Android devices.
mdmAssetId string required
Match pattern: ^[a-fA-F0-9]{24}$
location string required
≤ 256 characters
assetName string optional
≤ 256 characters
scope string required
user system all-users
assetsInfo array [object] optional
Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.
updatedAt string optional
ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.
createdAt string optional
ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.
agentConfiguration object optional
MDM agent behavior settings controlling location tracking application monitoring and network status reporting on Android devices.
allowLocation boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
allowNetworkStatus boolean optional
kioskLauncherConfiguration object optional
Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.
displayDeviceName boolean optional
settingAction any optional
whitelistedApps array [string] optional
escapeHatchPassword string optional
≤ 256 characters
backgroundUrl string optional
≤ 500 characters
iconSize string optional
small medium large
screenAlwaysOn boolean optional
unlockPassword string optional
≤ 256 characters
inactivityLockTime integer optional
≥ 0 · ≤ 9007199254740991
startingUpApps array [object] optional
packageName string required
≤ 256 characters
config object required
appsLayout array optional
type string required
folder
package string required
≤ 256 characters
action any required
children array required
header object optional
text string optional
≤ 1000 characters
fontSize string optional
small medium large
footer object optional
text string optional
≤ 1000 characters
fontSize string optional
small medium large
certificateProviderIds array optional
List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.
applications array [object] required
List of application assignments defining managed apps with installation actions configuration and update policies for deployment.
emmApplicationId string required
Match pattern: ^[a-fA-F0-9]{24}$
configuration string optional
action string optional
forceInstall available
updatePolicy object optional
customAppConfig object optional
applicationsInfo array [object] required
Enriched application metadata including app details names icons versions for dashboard display and reporting purposes.
emmApplicationId string required
Match pattern: ^[a-fA-F0-9]{24}$
emmApplication object optional
id string required
Unique identifier for the Android enterprise application configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string required
Unique identifier for organization managing Android enterprise application deployments and configurations.
Match pattern: ^[a-fA-F0-9]{24}$
emmEnterpriseId string required
Unique identifier for Android Enterprise enrollment binding application to Google Play managed configuration.
Match pattern: ^[a-fA-F0-9]{24}$
type string required
Application source type specifying build selection strategy for enterprise deployment and version management.
build lastBuild lastGitBranchBuild lastGitTagBuild lastTagBuild
config object required
Configuration object defining application source and version selection strategy for enterprise deployment.
version integer optional
Sequential version number tracking Android enterprise application configuration changes and synchronization state.
≥ 0 · ≤ 9007199254740991
updatedAt string required
Timestamp indicating when Android enterprise application configuration was last modified or synchronized.
createdAt string required
Timestamp indicating when Android enterprise application configuration was initially created in system.
origin any optional
Application source origin indicating whether application comes from organization library or public catalog.
info object optional
Detailed application metadata including version information, assets, and signing details for deployment.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0 · ≤ 9007199254740991
rules array [object] optional
Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
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
version string optional
Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
updatedAt string optional
Timestamp indicating when enrollment template configuration was last modified or synchronized.
createdAt string optional
Timestamp indicating when enrollment template configuration was initially created in system.
devicesCount integer optional
Total number of Android devices currently enrolled and managed using this enrollment template.
≥ 0 · ≤ 9007199254740991
defaultZeroTouchConfiguration boolean optional
Flag designating template as default configuration for Android zero-touch enrollment automatic device provisioning.
defaultManagedDomain boolean optional
Flag designating template as default configuration for managed Google domain enrollment workflows.
auxiliaryFields array [object] optional
Array of custom input fields collected from users during enrollment for conditional policy application.
type string optional
select text
key string required
≤ 128 characters
title any optional
description any optional
options array [string] optional
signinDetail object optional
signinUrl string optional
Google Play enrollment URL for manual device enrollment accessing Android Enterprise configuration.
≤ 500 characters
signinEnrollmentToken string optional
Short enrollment token code for manual entry during Android Enterprise device setup process.
≤ 500 characters
qrCode string optional
Base64-encoded QR code image for scanning during Android device enrollment for automated configuration.
≤ 1000 characters
allowPersonalUsage string optional
Android work profile personal usage permission setting controlling user access to personal apps and data.
ALLOW_PERSONAL_USAGE_UNSPECIFIED PERSONAL_USAGE_ALLOWED PERSONAL_USAGE_DISALLOWED PERSONAL_USAGE_DISALLOWED_USERLESS
defaultStatus string optional
Sign-in detail default status indicator specifying if configuration is primary enrollment method.
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED SIGNIN_DETAIL_IS_DEFAULT SIGNIN_DETAIL_IS_NOT_DEFAULT
enrollmentLink string optional
Direct enrollment link URL combining token and configuration for simplified device enrollment workflow.
≤ 500 characters
loginProviderTypes array [string] optional
Array of authentication provider types permitted for user verification during device enrollment workflow.
allowAutoContinue boolean optional
Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
managementMode string optional
Android Enterprise management mode specifying device ownership and profile configuration for enrolled devices.
DEVICE_OWNER PROFILE_OWNER COPE USERLESS
segmentId integer optional
Segment identifier for scoping smart enrollment into an specific segment
≥ 0 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "emmEnrollmentTokenId": "string",
        "emmEnrollmentToken": {
            "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
        },
        "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": "string",
            "createdAt": "string",
            "agentConfiguration": {
                "allowLocation": true,
                "allowPackageTime": true,
                "allowPackageTransfer": true,
                "allowNetworkStatus": true
            },
            "kioskLauncherConfiguration": {
                "displayDeviceName": true,
                "settingAction": "",
                "whitelistedApps": [
                    "string"
                ],
                "escapeHatchPassword": "string",
                "backgroundUrl": "string",
                "iconSize": "small",
                "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": {
                        "id": "string",
                        "organizationId": "string",
                        "emmEnterpriseId": "string",
                        "type": "build",
                        "config": {
                            "buildId": "string",
                            "applicationId": "string",
                            "mdmAssetId": "string",
                            "filter": "string"
                        },
                        "version": 0,
                        "updatedAt": "string",
                        "createdAt": "string",
                        "origin": "library",
                        "info": {
                            "id": "string",
                            "bundleId": "string",
                            "name": "string",
                            "icon": "string",
                            "processedVersionName": "string",
                            "versionCode": "string",
                            "size": "string",
                            "originalExtension": "string",
                            "applicationInfo": {
                                "id": "string",
                                "slug": "string",
                                "name": "string",
                                "picture": "string"
                            },
                            "disabled": true,
                            "signatures": {
                                "sha1": "string",
                                "sha256": "string"
                            }
                        }
                    }
                }
            ],
            "segmentId": 0
        },
        "rules": [
            {
                "name": "string",
                "displayNamePattern": "string",
                "tags": [
                    "string"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "string"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "string"
                            ]
                        ],
                        "patterns": [
                            "string"
                        ],
                        "identifiers": [
                            "string"
                        ]
                    }
                ],
                "emmPolicyId": "string",
                "emmPolicyAssignments": [
                    {
                        "emmPolicyId": "string",
                        "priority": 0
                    }
                ],
                "segmentId": 0
            }
        ],
        "version": "string",
        "updatedAt": "string",
        "createdAt": "string",
        "devicesCount": 0,
        "defaultZeroTouchConfiguration": true,
        "defaultManagedDomain": true,
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "string",
                "title": "string",
                "description": "string",
                "options": [
                    "string"
                ]
            }
        ],
        "signinDetail": {
            "signinUrl": "string",
            "signinEnrollmentToken": "string",
            "qrCode": "string",
            "allowPersonalUsage": "ALLOW_PERSONAL_USAGE_UNSPECIFIED",
            "defaultStatus": "SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED",
            "enrollmentLink": "string"
        },
        "loginProviderTypes": [
            "ldap"
        ],
        "allowAutoContinue": true,
        "managementMode": "DEVICE_OWNER",
        "segmentId": 0
    }
}
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"
    }
}