Logon Script Config

{
    "window_title": "Identity360 Enrollment reminder",
    "window_content": "You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.",
    "enrollment_button": "Enroll now",
    "force_enrollment": "true",
    "cancellation_button": "Remind me later"
}

Get Logon Script Config

The Get Logon Script Config API can be used to get the default logon script configuration for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/protection/quick-enrollment/logon-script-config", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-config",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": {
        "window_title": "Identity360 Enrollment reminder",
        "window_content": "You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.",
        "enrollment_button": "Enroll now",
        "force_enrollment": "true",
        "cancellation_button": "Remind me later"
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Replace Logon Script Config

The Replace Logon Script Config API can be used to replace the default logon script configuration for quick enrollment.
Note: This API replaces the entire logon script configuration. If you want to partially update the configuration, use the Partial Update Logon Script Config API.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.WRITE,id360.quick_enrollment.UPDATE

Arguments

window_title

string

Title of the logon script window

window_content

string

Content of the logon script window

enrollment_button

string

Text for the enrollment button in the logon script window

force_enrollment

string

Indicates if enrollment is mandatory

cancellation_button

string

Text for the cancellation button in the logon script window

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config")
  .put(body)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/v1/protection/quick-enrollment/logon-script-config", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-config",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "window_title": "Identity360 Enrollment reminder",
    "window_content": "You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.",
    "enrollment_button": "Enroll now",
    "force_enrollment": "true",
    "cancellation_button": "Remind me later"
}

{
    "data": {
        "window_title": "Identity360 Enrollment reminder",
        "window_content": "You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.",
        "enrollment_button": "Enroll now",
        "force_enrollment": "true",
        "cancellation_button": "Remind me later"
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Partial Update Logon Script Config

The Partial Update Logon Script Config API can be used to partially update the default logon script configuration for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.WRITE,id360.quick_enrollment.UPDATE

Arguments

window_title

string

Title of the logon script window

window_content

string

Content of the logon script window

enrollment_button

string

Text for the enrollment button in the logon script window

force_enrollment

string

Indicates if enrollment is mandatory

cancellation_button

string

Text for the cancellation button in the logon script window

Request Example

parameters_data='{"window_title":"Identity360 Enrollment reminder","window_content":"You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.","enrollment_button":"Enroll now","force_enrollment":"true","cancellation_button":"Remind me later"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config"
type: PATCH
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"window_title\":\"Identity360 Enrollment reminder\",\"window_content\":\"You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.\",\"enrollment_button\":\"Enroll now\",\"force_enrollment\":\"true\",\"cancellation_button\":\"Remind me later\"}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config")
  .patch(body)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"window_title":"Identity360 Enrollment reminder","window_content":"You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.","enrollment_button":"Enroll now","force_enrollment":"true","cancellation_button":"Remind me later"}'
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"window_title\":\"Identity360 Enrollment reminder\",\"window_content\":\"You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.\",\"enrollment_button\":\"Enroll now\",\"force_enrollment\":\"true\",\"cancellation_button\":\"Remind me later\"}"

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PATCH", "/api/v1/protection/quick-enrollment/logon-script-config", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PATCH",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-config",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  window_title: 'Identity360 Enrollment reminder',
  window_content: 'You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.',
  enrollment_button: 'Enroll now',
  force_enrollment: 'true',
  cancellation_button: 'Remind me later'
}));
req.end();

curl --request PATCH \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"window_title":"Identity360 Enrollment reminder","window_content":"You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.","enrollment_button":"Enroll now","force_enrollment":"true","cancellation_button":"Remind me later"}'

{
    "window_title": "Identity360 Enrollment reminder",
    "window_content": "You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.",
    "enrollment_button": "Enroll now",
    "force_enrollment": "true",
    "cancellation_button": "Remind me later"
}

{
    "data": {
        "window_title": "Identity360 Enrollment reminder",
        "window_content": "You are yet enroll for MFA. Please enroll now to access protected resources and reset passwords on your own.",
        "enrollment_button": "Enroll now",
        "force_enrollment": "true",
        "cancellation_button": "Remind me later"
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Download Logon Script Config

The Download Logon Script Config API can be used to download the default logon script configuration for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config/download"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config/download")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config/download', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/protection/quick-enrollment/logon-script-config/download", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-config/download",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-config/download \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

"logon_script_config.json"

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Get Logon Script Auto Schedule

The Get Logon Script Auto Schedule API can be used to get the default logon script auto schedule configuration for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/protection/quick-enrollment/logon-script-auto-schedule", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-auto-schedule",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": {
        "is_enabled": true,
        "domains": [
            {
                "id": "200090909090",
                "ous": {
                    "selected": [
                        20000909435000,
                        20000909435030,
                        20000909435004
                    ],
                    "unselected": [
                        20000909435900,
                        20000082399090
                    ],
                    "exclude_child_ou": false
                }
            }
        ],
        "schedule_settings": {
            "scheduler_interval_type": "WEEKLY",
            "hours": "21",
            "minutes": "0",
            "day_of_week": "5",
            "day_of_month": "10",
            "month_of_year": "12"
        }
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Replace Logon Script Auto Schedule

The Replace Logon Script Auto Schedule API can be used to replace the default logon script auto schedule configuration for quick enrollment.
Note: This API replaces the entire logon script auto schedule configuration. If you want to partially update the configuration, use the Partial Update Logon Script Auto Schedule API.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.WRITE,id360.quick_enrollment.UPDATE

Arguments

is_enabled

boolean

Indicates if the logon script auto schedule is enabled

domains

array

Show Sub-Attributes

string

ID of the domain to which the logon script will be applied

ous

object

Show Sub-Attributes

selected

array

List of selected OU IDs within the domain

unselected

array

List of unselected OU IDs within the domain

exclude_child_ou

boolean

Indicates if child OUs should be excluded from the schedule

schedule_settings

object

Show Sub-Attributes

scheduler_interval_type

string

The interval type for the schedule.

Allowed Values:

DAILY
WEEKLY
MONTHLY

hours

string

The hour at which the logon script will run

minutes

string

The minute at which the logon script will run

day_of_week

string

The day of the week for the schedule (1-7, where 1 is Sunday)

day_of_month

string

The day of the month for the schedule (1-31)

month_of_year

string

The month of the year for the schedule (1-12)

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule")
  .put(body)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/v1/protection/quick-enrollment/logon-script-auto-schedule", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-auto-schedule",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "is_enabled": true,
    "domains": [
        {
            "id": "200090909090",
            "ous": {
                "selected": [
                    20000909435000,
                    20000909435030,
                    20000909435004
                ],
                "unselected": [
                    20000909435900,
                    20000082399090
                ],
                "exclude_child_ou": false
            }
        }
    ],
    "schedule_settings": {
        "scheduler_interval_type": "WEEKLY",
        "hours": "21",
        "minutes": "0",
        "day_of_week": "5",
        "day_of_month": "10",
        "month_of_year": "12"
    }
}

{
    "data": {
        "is_enabled": true,
        "domains": [
            {
                "id": "200090909090",
                "ous": {
                    "selected": [
                        20000909435000,
                        20000909435030,
                        20000909435004
                    ],
                    "unselected": [
                        20000909435900,
                        20000082399090
                    ],
                    "exclude_child_ou": false
                }
            }
        ],
        "schedule_settings": {
            "scheduler_interval_type": "WEEKLY",
            "hours": "21",
            "minutes": "0",
            "day_of_week": "5",
            "day_of_month": "10",
            "month_of_year": "12"
        }
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Partial Update Logon Script Auto Schedule

The Partial Update Logon Script Auto Schedule API can be used to partially update the default logon script auto schedule configuration for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.WRITE,id360.quick_enrollment.UPDATE

Arguments

is_enabled

boolean

Indicates if the logon script auto schedule is enabled

domains

array

Show Sub-Attributes

string

ID of the domain to which the logon script will be applied

ous

object

Show Sub-Attributes

selected

array

List of selected OU IDs within the domain

unselected

array

List of unselected OU IDs within the domain

exclude_child_ou

boolean

Indicates if child OUs should be excluded from the schedule

schedule_settings

object

Show Sub-Attributes

scheduler_interval_type

string

The interval type for the schedule.

Allowed Values:

DAILY
WEEKLY
MONTHLY

hours

string

The hour at which the logon script will run

minutes

string

The minute at which the logon script will run

day_of_week

string

The day of the week for the schedule (1-7, where 1 is Sunday)

day_of_month

string

The day of the month for the schedule (1-31)

month_of_year

string

The month of the year for the schedule (1-12)

Request Example

parameters_data='{"is_enabled":true,"domains":[{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}}],"schedule_settings":{"scheduler_interval_type":"WEEKLY","hours":"21","minutes":"0","day_of_week":"5","day_of_month":"10","month_of_year":"12"}}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule"
type: PATCH
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"is_enabled\":true,\"domains\":[{\"id\":\"200090909090\",\"ous\":{\"selected\":[20000909435000,20000909435030,20000909435004],\"unselected\":[20000909435900,20000082399090],\"exclude_child_ou\":false}}],\"schedule_settings\":{\"scheduler_interval_type\":\"WEEKLY\",\"hours\":\"21\",\"minutes\":\"0\",\"day_of_week\":\"5\",\"day_of_month\":\"10\",\"month_of_year\":\"12\"}}");
Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule")
  .patch(body)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"is_enabled":true,"domains":[{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}}],"schedule_settings":{"scheduler_interval_type":"WEEKLY","hours":"21","minutes":"0","day_of_week":"5","day_of_month":"10","month_of_year":"12"}}'
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

payload = "{\"is_enabled\":true,\"domains\":[{\"id\":\"200090909090\",\"ous\":{\"selected\":[20000909435000,20000909435030,20000909435004],\"unselected\":[20000909435900,20000082399090],\"exclude_child_ou\":false}}],\"schedule_settings\":{\"scheduler_interval_type\":\"WEEKLY\",\"hours\":\"21\",\"minutes\":\"0\",\"day_of_week\":\"5\",\"day_of_month\":\"10\",\"month_of_year\":\"12\"}}"

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PATCH", "/api/v1/protection/quick-enrollment/logon-script-auto-schedule", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PATCH",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-auto-schedule",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  is_enabled: true,
  domains: [
    {
      id: '200090909090',
      ous: {
        selected: [20000909435000, 20000909435030, 20000909435004],
        unselected: [20000909435900, 20000082399090],
        exclude_child_ou: false
      }
    }
  ],
  schedule_settings: {
    scheduler_interval_type: 'WEEKLY',
    hours: '21',
    minutes: '0',
    day_of_week: '5',
    day_of_month: '10',
    month_of_year: '12'
  }
}));
req.end();

curl --request PATCH \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"is_enabled":true,"domains":[{"id":"200090909090","ous":{"selected":[20000909435000,20000909435030,20000909435004],"unselected":[20000909435900,20000082399090],"exclude_child_ou":false}}],"schedule_settings":{"scheduler_interval_type":"WEEKLY","hours":"21","minutes":"0","day_of_week":"5","day_of_month":"10","month_of_year":"12"}}'

{
    "is_enabled": true,
    "domains": [
        {
            "id": "200090909090",
            "ous": {
                "selected": [
                    20000909435000,
                    20000909435030,
                    20000909435004
                ],
                "unselected": [
                    20000909435900,
                    20000082399090
                ],
                "exclude_child_ou": false
            }
        }
    ],
    "schedule_settings": {
        "scheduler_interval_type": "WEEKLY",
        "hours": "21",
        "minutes": "0",
        "day_of_week": "5",
        "day_of_month": "10",
        "month_of_year": "12"
    }
}

{
    "data": {
        "is_enabled": true,
        "domains": [
            {
                "id": "200090909090",
                "ous": {
                    "selected": [
                        20000909435000,
                        20000909435030,
                        20000909435004
                    ],
                    "unselected": [
                        20000909435900,
                        20000082399090
                    ],
                    "exclude_child_ou": false
                }
            }
        ],
        "schedule_settings": {
            "scheduler_interval_type": "WEEKLY",
            "hours": "21",
            "minutes": "0",
            "day_of_week": "5",
            "day_of_month": "10",
            "month_of_year": "12"
        }
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Get Logon Script Auto Schedule History

The Get Logon Script Auto Schedule History API can be used to get all the history of logon script auto schedule runs for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.READ

Query Parameters

from

The starting index of the records to return in the response.

limit

The maximum number of records to return in the response.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/history"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/history")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/history', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/protection/quick-enrollment/logon-script-auto-schedule/history", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-auto-schedule/history",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/history \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "id": "2000000293042",
            "start_time": "2023-10-27T03:30:12Z",
            "end_time": "2023-10-27T03:35:12Z",
            "total_attempted_count": 100,
            "success_count": 100
        },
        {
            "id": "2000000293043",
            "start_time": "2023-10-27T04:00:00Z",
            "end_time": "2023-10-27T04:05:00Z",
            "total_attempted_count": 150,
            "success_count": 150
        },
        {
            "id": "2000000293044",
            "start_time": "2023-10-27T04:30:00Z",
            "end_time": "2023-10-27T04:35:00Z",
            "total_attempted_count": 150,
            "success_count": 150
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 100,
        "total_no_of_objects": 3
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Get Logon Script Auto Schedule Script Copy Status

The Get Logon Script Auto Schedule Script Copy Status API can be used to get the last script copy status on SYSVOL folder for quick enrollment.
OAuth Scope : id360.quick_enrollment.ALL,id360.quick_enrollment.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/script-copy-status"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/script-copy-status")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/script-copy-status', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/protection/quick-enrollment/logon-script-auto-schedule/script-copy-status", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/protection/quick-enrollment/logon-script-auto-schedule/script-copy-status",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/protection/quick-enrollment/logon-script-auto-schedule/script-copy-status \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "domain_name": "zohocorp.com",
            "script_availability": "Yes",
            "last_updated_time": "2023-10-27T03:30:12Z",
            "last_updated_status_type": "success",
            "last_updated_status_message": "Success"
        },
        {
            "domain_name": "example.com",
            "script_availability": "No",
            "last_updated_time": "2023-10-27T04:00:00Z",
            "last_updated_status_type": "failure",
            "last_updated_status_message": "Permission denied"
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 100,
        "total_no_of_objects": 3
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}