Generate Device Owner Enrollment QR for Template

Tool Name: airdroid_business_provisioning_template_device_owner_enrollment_qr_generate

Risk Level: 🟢 Low Risk

Execution Mode: ⚡ Synchronous

Category: Provisioning Templates

Quick Start (Copy & Use)

Summary: Generate a Device Owner enrollment QR code (SVG markup or PNG Base64) for a provisioning template. This QR is the Device Owner registration code used in the console enrollment flow — it is rendered from the template's configuration_code.

Prerequisites: ProvisioningId (positive integer ≥ 1) — obtain via List Provisioning Templates. The template must be Android with packapk_progress = "Package ready" (check via Get a Provisioning Template). A valid OAuth2 AccessToken configured in the GI node Credential.

Success Criteria: StatusCode == 200, ErrorMessage == "", and ProvisionCode is non-empty.

Enrollment implications: A device that scans this QR during factory setup is enrolled as a fully managed Device Owner device under the template's group/policy configuration. Treat the QR as an enrollment secret — anyone with it can enroll devices into your organization.

> 🚨 Output integrity — do not modify ProvisionCode: The QR payload is a very long string (tens of KB of SVG markup or PNG Base64). It must be passed on verbatim and in full — never truncate it, insert ..., summarize, rewrite, or re-encode it. One changed character makes the QR unscannable. Reference the output variable directly in downstream nodes instead of copying it into prose.

What to Do Next: Pass ProvisionCode directly (by variable reference) to a display, email, or file node; scan the QR on the target device during Android factory setup.

Minimal Request Example (recommended to copy directly):

{
  "ProvisioningId": 100
}

Minimal Response Example:

{
  "ProvisionCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

> Note: the ProvisionCode value above is shortened only to keep this document readable — a real payload is tens of kilobytes. In actual responses it must always be handled complete and unmodified.

Recipes (Common Recipes)

Recipe 1: Generate a QR for a Known Template

When to use: You already have an Android template's ProvisioningId and its package is ready.

{
  "ProvisioningId": 17563
}

Recipe 2: Verify Readiness First, Then Generate

When to use: You are unsure whether the template's configuration_code is available. Call Get a Provisioning Template first and check platform_type, packapk_progress, and configuration_code; generate the QR only when packapk_progress == "Package ready".

{
  "ProvisioningId": 100
}

Recipe 3: Retry After Packaging Completes

When to use: A previous call returned Retryable = true with ErrorMessage containing packapk_progress (e.g. "Packaging in progress"). Poll Get a Provisioning Template until packapk_progress == "Package ready", then re-invoke with the same ID.

{
  "ProvisioningId": 100
}

1. Overview

1.1 Description

Generate a Device Owner enrollment QR code for a provisioning template. Internally the workflow:

1. Calls Get a Provisioning Template with the given ProvisioningId
2. Extracts the template's configuration_code
3. If the code is non-empty, renders it as a QR image (SVG markup or PNG Base64) and returns it in ProvisionCode
4. If the code is empty or the lookup fails, returns an empty ProvisionCode with a diagnostic ErrorMessage / Hint derived from platform_type / packapk_progress

1.2 When to Use

• Device Owner enrollment: Produce the registration QR scanned during Android factory setup to enroll devices as fully managed under the template's configuration
• Enrollment kits: Embed the QR into onboarding documents or displays for field provisioning

Don't use when:

• The template is Windows — Windows templates never provide configuration_code; use the template's deploy_code (from Get a Provisioning Template) instead
• You don't have the ProvisioningId — call List Provisioning Templates first

1.3 Execution Mode and Response

This operation is synchronous (template lookup + QR render only; it is effectively read-only and creates no server-side changes). Returns:

• ProvisionCode: The QR payload (empty string on any failure path)
• StatusCode / ErrorMessage / Hint / Retryable / OriginalStatusCode: Call status and error information

1.4 Prerequisites

1.5 Prerequisite Tools

1.6 Differences from Similar Tools

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`ProvisioningId`

Provisioning template unique identifier.

• Type: number
• Required: Yes
• Format: Positive integer greater than 0. Invalid values fail the underlying template lookup with StatusCode = -1
• Source: The provisioning_id field of items returned by List Provisioning Templates
• How to fill in GI node:
  • Constant: Enter the numeric ID directly, e.g. 17563
  • Upstream reference: Use ProvisioningList[0].provisioning_id from a List Provisioning Templates node output, or Provisioning.provisioning_id from Get a Provisioning Template
• Example:

17563

2.3 Parameter Combination Logic

ProvisioningId is the only business input; there are no combination rules.

3. Outputs

3.1 Response Example

Success response: see the Quick Start minimal response example above.

Error response (Windows template — QR unsupported):

{
  "ProvisionCode": "",
  "Hint": "Call 'Get a Provisioning Template' with the same ProvisioningId and use the returned deploy_code for Windows enrollment. Do not retry this tool for Windows templates.",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": "Windows provisioning templates do not provide configuration_code or enrollment QR codes. Use deploy_code from 'Get a Provisioning Template' instead."
}

Error response (Android package not ready — retryable):

{
  "ProvisionCode": "",
  "Hint": "Wait until packapk_progress becomes 'Package ready', then retry 'Generate Device Owner Enrollment QR for Template' with the same ProvisioningId. You can check status via 'Get a Provisioning Template'.",
  "Retryable": true,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": "configuration_code is empty. packapk_progress: Packaging in progress."
}

3.2 Field Descriptions

3.3 Status Code / Enum Value Mapping

Retryable for the "configuration_code unavailable" path is derived from packapk_progress:

3.4 Determining the Outcome

4. Examples

4.1 Basic Example: Generate the Enrollment QR

Request Parameters:

{
  "ProvisioningId": 100
}

Response: see the Quick Start minimal response example. Deliver ProvisionCode by variable reference — never inline-edit it.

4.2 Advanced Example: Poll Until Package Ready

Scenario: The first call reports packaging in progress.

1. Call this tool → response has Retryable = true, ErrorMessage = "configuration_code is empty. packapk_progress: Packaging in progress."
2. Poll Get a Provisioning Template with the same ProvisioningId every few minutes until Provisioning.packapk_progress == "Package ready"
3. Re-invoke this tool with the same ProvisioningId:

{
  "ProvisioningId": 100
}

4.3 Error Example: Template Not Found

Request Parameters:

{
  "ProvisioningId": 99999
}

Response:

{
  "ProvisionCode": "",
  "Hint": "Provisioning template was not found; obtain provisioning_id via 'List Provisioning Templates' and retry.",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": "Provisioning template not found."
}

5. Error Handling

5.1 AB Three-Layer Error Codes

5.2 Common Errors

5.3 Agent Self-Healing Decision Table

6. Best Practices

6.1 Performance Optimization

• Pre-check readiness with Get a Provisioning Template to avoid wasted calls while Android packaging is in progress
• Do not route ProvisionCode through an LLM message: the payload is tens of KB. Wire it directly from this node's output into the consuming node (display / file / email) by variable reference — this saves tokens and eliminates corruption risk

6.2 Security Considerations

🟢 Read operation (lookup + QR render only; no server-side changes). However, mind the enrollment implications:

• Scanning this QR during Android factory setup enrolls the device as a fully managed Device Owner device under the template's group/policy configuration
• Treat the QR (and the underlying configuration_code) as an enrollment secret: anyone who obtains it can enroll devices into your organization — share it only through controlled channels and regenerate it if the template changes

🚨 Output integrity: ProvisionCode must never be truncated, elided with ..., re-encoded, or otherwise rewritten by the model or any intermediate node. A single altered character renders the QR unscannable.

6.3 Idempotency

Idempotency: Naturally idempotent. Read-only; repeated calls with the same ProvisioningId return the same QR (unless the template's configuration_code changes, e.g. after repackaging).

7. Related Tools

7.1 Prerequisite Tools

7.2 Follow-up Tools

7.3 Similar Tool Comparison

8. Tool Chains

8.1 Full Enrollment QR Flow

Scenario: Produce an enrollment QR for a template known only by name.

Tool Chain:

List Provisioning Templates → Get a Provisioning Template → Generate Device Owner Enrollment QR for Template

Steps:

1. Call List Provisioning Templates with a Name keyword and PlatformType = 1 (Android)
2. Call Get a Provisioning Template with the matched provisioning_id; verify packapk_progress == "Package ready" and configuration_code non-empty
3. Call Generate Device Owner Enrollment QR for Template with the same ID; deliver ProvisionCode verbatim

8.2 Packaging-Pending Retry Loop

Scenario: The template's APK package is still being built.

Tool Chain:

Generate Device Owner Enrollment QR for Template → (Retryable=true) → Get a Provisioning Template (poll packapk_progress) → Generate Device Owner Enrollment QR for Template

Steps:

1. First call returns Retryable = true with packapk_progress in ErrorMessage
2. Poll Get a Provisioning Template until packapk_progress == "Package ready"
3. Re-invoke this tool with the same ProvisioningId

Appendix Reference:

• Field Reference: ./Field Reference.md
• Error Code Quick Reference: ./Error Codes.md