Favicon

You are here: Home > API Reference > EmmEnrollmentTemplates > Update emmEnrollmentTemplate

Update emmEnrollmentTemplate

Update emmEnrollmentTemplate

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

Update emmEnrollmentTemplate

Update emmEnrollmentTemplate

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Entity Id or Slug
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
emmEnrollmentTemplateId string
required
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
Body Params application/json
name string optional
≤ 128 characters
description string optional
≤ 256 characters
rules array [object] optional
name string optional
≤ 256 characters
displayNamePattern string optional
≤ 256 characters
tags array [string] optional
conditions array [object] optional
tags array [array] optional
auxiliaryFields array [array] optional
patterns array [string] optional
identifiers array [string] optional
emmPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
emmPolicyAssignments array [object] optional
emmPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
priority integer required
≥ 0 · ≤ 10000
auxiliaryFields array [object] optional
type string optional
select text
key string required
≤ 128 characters
title string optional
≤ 128 characters
description string optional
≤ 256 characters
options array [string] optional
loginProviderTypes array [string] optional
allowAutoContinue boolean optional
{
    "name": "string",
    "description": "string",
    "rules": [
        {
            "name": "string",
            "displayNamePattern": "string",
            "tags": [
                "string"
            ],
            "conditions": [
                {
                    "tags": [
                        [
                            "string"
                        ]
                    ],
                    "auxiliaryFields": [
                        [
                            "string"
                        ]
                    ],
                    "patterns": [
                        "string"
                    ],
                    "identifiers": [
                        "string"
                    ]
                }
            ],
            "emmPolicyId": "string",
            "emmPolicyAssignments": [
                {
                    "emmPolicyId": "string",
                    "priority": 0
                }
            ]
        }
    ],
    "auxiliaryFields": [
        {
            "type": "select",
            "key": "string",
            "title": "string",
            "description": "string",
            "options": [
                "string"
            ]
        }
    ],
    "loginProviderTypes": [
        "ldap"
    ],
    "allowAutoContinue": true
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
description string optional
≤ 256 characters
emmEnrollmentTokenId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
emmPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
rules array [object] optional
name string optional
≤ 256 characters
displayNamePattern string optional
≤ 256 characters
tags array [string] optional
conditions array [object] optional
tags array [array] optional
auxiliaryFields array [array] optional
patterns array [string] optional
identifiers array [string] optional
emmPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
emmPolicyAssignments array [object] optional
emmPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
priority integer required
≥ 0 · ≤ 10000
version string optional
≤ 128 characters
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
devicesCount integer optional
≥ 0
defaultZeroTouchConfiguration boolean optional
defaultManagedDomain boolean optional
auxiliaryFields array [object] optional
type string optional
select text
key string required
≤ 128 characters
title string optional
≤ 128 characters
description string optional
≤ 256 characters
options array [string] optional
signinDetails object optional
signinUrl string optional
≤ 500 characters
signinEnrollmentToken string optional
≤ 500 characters
qrCode string optional
≤ 1000 characters
allowPersonalUsage string optional
ALLOW_PERSONAL_USAGE_UNSPECIFIED PERSONAL_USAGE_ALLOWED PERSONAL_USAGE_DISALLOWED PERSONAL_USAGE_DISALLOWED_USERLESS
defaultStatus string optional
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED SIGNIN_DETAIL_IS_DEFAULT SIGNIN_DETAIL_IS_NOT_DEFAULT
enrollmentLink string optional
≤ 500 characters
loginProviderTypes array [string] optional
allowAutoContinue boolean optional
managementMode string optional
DEVICE_OWNER PROFILE_OWNER COPE USERLESS
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "emmEnrollmentTokenId": "string",
        "emmPolicyId": "string",
        "rules": [
            {
                "name": "string",
                "displayNamePattern": "string",
                "tags": [
                    "string"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "string"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "string"
                            ]
                        ],
                        "patterns": [
                            "string"
                        ],
                        "identifiers": [
                            "string"
                        ]
                    }
                ],
                "emmPolicyId": "string",
                "emmPolicyAssignments": [
                    {
                        "emmPolicyId": "string",
                        "priority": 0
                    }
                ]
            }
        ],
        "version": "string",
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "devicesCount": 0,
        "defaultZeroTouchConfiguration": true,
        "defaultManagedDomain": true,
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "string",
                "title": "string",
                "description": "string",
                "options": [
                    "string"
                ]
            }
        ],
        "signinDetails": {
            "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"
    }
}
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": 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"
    }
}