Admin Setting
This is the documentation for the Admin Setting API of Conditional Access Policy in ID360.
Attribute
- recaptcha
- text_captcha
- InteractiveLogon
- MachineUnlock
- RDP
- SSH
- UAC
- Sudo
- hours
- days
- attempts
{
"passwordless_enabled_for_nps_vpn": true,
"captcha_type": "recaptcha",
"account_blocking_settings": {
"failed_attempts_threshold": 5,
"failed_attempts_reset_interval": 30,
"is_block_forever": false,
"blocking_duration": 30,
"reset_failure_attempts_on_success": true
},
"offline_mfa_settings": {
"is_enabled": true,
"devices_assignment": {
"device_ids": [
"2000000092642",
"2000000092643"
],
"group_ids": [
"2000000092616",
"2000000092617"
]
},
"actions": [
"InteractiveLogon",
"RDP"
],
"secondary_authentication": {
"no_of_required_factors": 1,
"factor_configs": [
{
"authn_factor_config_id": 200000012544,
"verification_order": 1,
"is_mandatory": true
}
]
},
"offline_verification_duration": {
"value": 30,
"unit": "hours"
},
"bypass_mfa_connection_error": true
}
}
Get Admin Settings
Retrieves the admin settings for the ID360 application.
OAuth Scope : id360.conditional_access_policy.read,id360.conditional_access_policy.all
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/admin-settings"
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/admin-settings")
.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/admin-settings', 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/admin-settings", 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/admin-settings",
"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/admin-settings \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": {
"passwordless_enabled_for_nps_vpn": true,
"captcha_type": "recaptcha",
"account_blocking_settings": {
"failed_attempts_threshold": 5,
"failed_attempts_reset_interval": 30,
"is_block_forever": false,
"blocking_duration": 30,
"reset_failure_attempts_on_success": true
},
"offline_mfa_settings": {
"is_enabled": true,
"devices_assignment": {
"device_ids": [
"2000000092642",
"2000000092643"
],
"group_ids": [
"2000000092616",
"2000000092617"
]
},
"actions": [
"InteractiveLogon",
"RDP"
],
"secondary_authentication": {
"no_of_required_factors": 1,
"factor_configs": [
{
"authn_factor_config_id": 200000012544,
"verification_order": 1,
"is_mandatory": true
}
]
},
"offline_verification_duration": {
"value": 30,
"unit": "hours"
},
"bypass_mfa_connection_error": true
}
}
}
{
"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."
}
}
Update Admin Settings
Updates the admin settings for the ID360 application.
OAuth Scope : id360.conditional_access_policy.create,id360.conditional_access_policy.write,id360.conditional_access_policy.all
Arguments
- recaptcha
- text_captcha
- InteractiveLogon
- MachineUnlock
- RDP
- SSH
- UAC
- Sudo
- hours
- days
- attempts
parameters_data='{"passwordless_enabled_for_nps_vpn":true,"captcha_type":"recaptcha","account_blocking_settings":{"failed_attempts_threshold":5,"failed_attempts_reset_interval":30,"is_block_forever":false,"blocking_duration":30,"reset_failure_attempts_on_success":true},"offline_mfa_settings":{"is_enabled":true,"devices_assignment":{"device_ids":["2000000092642","2000000092643"],"group_ids":["2000000092616","2000000092617"]},"actions":["InteractiveLogon","RDP"],"secondary_authentication":{"no_of_required_factors":1,"factor_configs":[{"authn_factor_config_id":200000012544,"verification_order":1,"is_mandatory":true}]},"offline_verification_duration":{"value":30,"unit":"hours"},"bypass_mfa_connection_error":true}}';
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/admin-settings"
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, "{\"passwordless_enabled_for_nps_vpn\":true,\"captcha_type\":\"recaptcha\",\"account_blocking_settings\":{\"failed_attempts_threshold\":5,\"failed_attempts_reset_interval\":30,\"is_block_forever\":false,\"blocking_duration\":30,\"reset_failure_attempts_on_success\":true},\"offline_mfa_settings\":{\"is_enabled\":true,\"devices_assignment\":{\"device_ids\":[\"2000000092642\",\"2000000092643\"],\"group_ids\":[\"2000000092616\",\"2000000092617\"]},\"actions\":[\"InteractiveLogon\",\"RDP\"],\"secondary_authentication\":{\"no_of_required_factors\":1,\"factor_configs\":[{\"authn_factor_config_id\":200000012544,\"verification_order\":1,\"is_mandatory\":true}]},\"offline_verification_duration\":{\"value\":30,\"unit\":\"hours\"},\"bypass_mfa_connection_error\":true}}");
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/protection/admin-settings")
.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: '{"passwordless_enabled_for_nps_vpn":true,"captcha_type":"recaptcha","account_blocking_settings":{"failed_attempts_threshold":5,"failed_attempts_reset_interval":30,"is_block_forever":false,"blocking_duration":30,"reset_failure_attempts_on_success":true},"offline_mfa_settings":{"is_enabled":true,"devices_assignment":{"device_ids":["2000000092642","2000000092643"],"group_ids":["2000000092616","2000000092617"]},"actions":["InteractiveLogon","RDP"],"secondary_authentication":{"no_of_required_factors":1,"factor_configs":[{"authn_factor_config_id":200000012544,"verification_order":1,"is_mandatory":true}]},"offline_verification_duration":{"value":30,"unit":"hours"},"bypass_mfa_connection_error":true}}'
};
fetch('https://id360.manageengine.com/api/v1/protection/admin-settings', 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 = "{\"passwordless_enabled_for_nps_vpn\":true,\"captcha_type\":\"recaptcha\",\"account_blocking_settings\":{\"failed_attempts_threshold\":5,\"failed_attempts_reset_interval\":30,\"is_block_forever\":false,\"blocking_duration\":30,\"reset_failure_attempts_on_success\":true},\"offline_mfa_settings\":{\"is_enabled\":true,\"devices_assignment\":{\"device_ids\":[\"2000000092642\",\"2000000092643\"],\"group_ids\":[\"2000000092616\",\"2000000092617\"]},\"actions\":[\"InteractiveLogon\",\"RDP\"],\"secondary_authentication\":{\"no_of_required_factors\":1,\"factor_configs\":[{\"authn_factor_config_id\":200000012544,\"verification_order\":1,\"is_mandatory\":true}]},\"offline_verification_duration\":{\"value\":30,\"unit\":\"hours\"},\"bypass_mfa_connection_error\":true}}"
headers = {
'Accept': "application/json",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PATCH", "/api/v1/protection/admin-settings", 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/admin-settings",
"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({
passwordless_enabled_for_nps_vpn: true,
captcha_type: 'recaptcha',
account_blocking_settings: {
failed_attempts_threshold: 5,
failed_attempts_reset_interval: 30,
is_block_forever: false,
blocking_duration: 30,
reset_failure_attempts_on_success: true
},
offline_mfa_settings: {
is_enabled: true,
devices_assignment: {
device_ids: ['2000000092642', '2000000092643'],
group_ids: ['2000000092616', '2000000092617']
},
actions: ['InteractiveLogon', 'RDP'],
secondary_authentication: {
no_of_required_factors: 1,
factor_configs: [
{
authn_factor_config_id: 200000012544,
verification_order: 1,
is_mandatory: true
}
]
},
offline_verification_duration: {value: 30, unit: 'hours'},
bypass_mfa_connection_error: true
}
}));
req.end();
curl --request PATCH \
--url https://id360.manageengine.com/api/v1/protection/admin-settings \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"passwordless_enabled_for_nps_vpn":true,"captcha_type":"recaptcha","account_blocking_settings":{"failed_attempts_threshold":5,"failed_attempts_reset_interval":30,"is_block_forever":false,"blocking_duration":30,"reset_failure_attempts_on_success":true},"offline_mfa_settings":{"is_enabled":true,"devices_assignment":{"device_ids":["2000000092642","2000000092643"],"group_ids":["2000000092616","2000000092617"]},"actions":["InteractiveLogon","RDP"],"secondary_authentication":{"no_of_required_factors":1,"factor_configs":[{"authn_factor_config_id":200000012544,"verification_order":1,"is_mandatory":true}]},"offline_verification_duration":{"value":30,"unit":"hours"},"bypass_mfa_connection_error":true}}'
{
"passwordless_enabled_for_nps_vpn": true,
"captcha_type": "recaptcha",
"account_blocking_settings": {
"failed_attempts_threshold": 5,
"failed_attempts_reset_interval": 30,
"is_block_forever": false,
"blocking_duration": 30,
"reset_failure_attempts_on_success": true
},
"offline_mfa_settings": {
"is_enabled": true,
"devices_assignment": {
"device_ids": [
"2000000092642",
"2000000092643"
],
"group_ids": [
"2000000092616",
"2000000092617"
]
},
"actions": [
"InteractiveLogon",
"RDP"
],
"secondary_authentication": {
"no_of_required_factors": 1,
"factor_configs": [
{
"authn_factor_config_id": 200000012544,
"verification_order": 1,
"is_mandatory": true
}
]
},
"offline_verification_duration": {
"value": 30,
"unit": "hours"
},
"bypass_mfa_connection_error": true
}
}
{
"data": {
"passwordless_enabled_for_nps_vpn": true,
"captcha_type": "recaptcha",
"account_blocking_settings": {
"failed_attempts_threshold": 5,
"failed_attempts_reset_interval": 30,
"is_block_forever": false,
"blocking_duration": 30,
"reset_failure_attempts_on_success": true
},
"offline_mfa_settings": {
"is_enabled": true,
"devices_assignment": {
"device_ids": [
"2000000092642",
"2000000092643"
],
"group_ids": [
"2000000092616",
"2000000092617"
]
},
"actions": [
"InteractiveLogon",
"RDP"
],
"secondary_authentication": {
"no_of_required_factors": 1,
"factor_configs": [
{
"authn_factor_config_id": 200000012544,
"verification_order": 1,
"is_mandatory": true
}
]
},
"offline_verification_duration": {
"value": 30,
"unit": "hours"
},
"bypass_mfa_connection_error": true
}
}
}
{
"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."
}
}
List Offline Protection Devices
Retrieve a list of offline protection devices
OAuth Scope : id360.conditional_access_policy.read,id360.conditional_access_policy.all'
Query Parameters
eg: 50
eg: name eq "Policy 01"
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/admin-settings/offline-protected-devices"
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/admin-settings/offline-protected-devices")
.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/admin-settings/offline-protected-devices', 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/admin-settings/offline-protected-devices", 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/admin-settings/offline-protected-devices",
"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/admin-settings/offline-protected-devices \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": [
{
"id": "2000000092642",
"name": "Device 01",
"join_type": "Id360 Joined",
"primary_source": {
"id": "2000000072637",
"name": "Berge-Corp",
"application_service": {
"id": "2000000018007",
"display_name": "Universal Directory",
"name": "ZOHO_DIRECTORY",
"logo": "universal-directory"
}
},
"agent_status": "Active"
},
{
"id": "2000000092643",
"name": "Device 02",
"join_type": "Entra Joined",
"primary_source": {
"id": "2000000072637",
"name": "Berge-Corp",
"application_service": {
"id": "2000000018007",
"display_name": "Universal Directory",
"name": "ZOHO_DIRECTORY",
"logo": "universal-directory"
}
},
"agent_status": "Inactive"
}
],
"meta": {
"start_index": 1,
"limit": 100,
"total_no_of_objects": 1
}
}
{
"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."
}
}
List Offline Protection Groups
Retrieve a list of offline protection groups
OAuth Scope : id360.conditional_access_policy.read,id360.conditional_access_policy.all'
Query Parameters
eg: 50
eg: name eq "Policy 01"
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/admin-settings/offline-protected-device-groups"
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/admin-settings/offline-protected-device-groups")
.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/admin-settings/offline-protected-device-groups', 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/admin-settings/offline-protected-device-groups", 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/admin-settings/offline-protected-device-groups",
"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/admin-settings/offline-protected-device-groups \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": [
{
"id": "2000000092616",
"name": "Admins",
"type": "static",
"primary_source": {
"id": "2000000072637",
"name": "Berge-Corp",
"application_service": {
"id": "2000000018007",
"display_name": "Universal Directory",
"name": "ZOHO_DIRECTORY",
"logo": "universal-directory"
}
}
},
{
"id": "2000000092617",
"name": "Users",
"type": "dynamic",
"primary_source": {
"id": "2000000072637",
"name": "Berge-Corp",
"application_service": {
"id": "2000000018007",
"display_name": "Universal Directory",
"name": "ZOHO_DIRECTORY",
"logo": "universal-directory"
}
}
}
],
"meta": {
"start_index": 1,
"limit": 100,
"total_no_of_objects": 1
}
}
{
"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."
}
}