Update winEnrollmentTemplate

PUT

/v1/organizations/:organizationId/mdm/windows/enterprise/enrollment-templates/:winEnrollmentTemplateId

Update winEnrollmentTemplate

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

winEnrollmentTemplateId 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

winPolicyId string optional

Entity Id

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

winPolicyAssignments array [object] optional

winPolicyId 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

entraId object optional

mobilityApp object optional

tenantId string required

≤ 256 characters

clientId string required

≤ 256 characters

clientSecret string required

≤ 256 characters

{
    "name": "string",
    "description": "string",
    "rules": [
        {
            "name": "string",
            "displayNamePattern": "string",
            "tags": [
                "string"
            ],
            "conditions": [
                {
                    "tags": [
                        [
                            "string"
                        ]
                    ],
                    "auxiliaryFields": [
                        [
                            "string"
                        ]
                    ],
                    "patterns": [
                        "string"
                    ],
                    "identifiers": [
                        "string"
                    ]
                }
            ],
            "winPolicyId": "string",
            "winPolicyAssignments": [
                {
                    "winPolicyId": "string",
                    "priority": 0
                }
            ]
        }
    ],
    "auxiliaryFields": [
        {
            "type": "select",
            "key": "string",
            "title": "string",
            "description": "string",
            "options": [
                "string"
            ]
        }
    ],
    "loginProviderTypes": [
        "ldap"
    ],
    "allowAutoContinue": true,
    "entraId": {
        "mobilityApp": {
            "tenantId": "string",
            "clientId": "string",
            "clientSecret": "string"
        }
    }
}

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

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

winPolicyId string optional

Entity Id

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

winPolicyAssignments array [object] optional

winPolicyId 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

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

{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "rules": [
            {
                "name": "string",
                "displayNamePattern": "string",
                "tags": [
                    "string"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "string"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "string"
                            ]
                        ],
                        "patterns": [
                            "string"
                        ],
                        "identifiers": [
                            "string"
                        ]
                    }
                ],
                "winPolicyId": "string",
                "winPolicyAssignments": [
                    {
                        "winPolicyId": "string",
                        "priority": 0
                    }
                ]
            }
        ],
        "version": "string",
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "devicesCount": 0,
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "string",
                "title": "string",
                "description": "string",
                "options": [
                    "string"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap"
        ],
        "allowAutoContinue": true
    }
}

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