Users
User APIs for ID360, to manage users in your account.
Attribute
- 1
- 0
{
"city": "Anchorage",
"company": "Berge Corporation",
"country": "US",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"id": "2000000000001",
"isDomainVerified": false,
"language": "en",
"lastName": "Hales",
"manager": "2000000072269",
"mobileNumber": "7700900461",
"password": "Test@1527#",
"postOfficeBox": "1052",
"primarySource": {
"applicationName": "Berge-Corp",
"applicationService": {
"name": "Universal Directory",
"id": "2000000018007",
"logo": "universal-directory",
"serviceName": "ZOHO_DIRECTORY"
},
"creationTime": "2023-12-12T14:32:50+05:30",
"isEnabled": true,
"id": "2000000072637",
"modifiedTime": "2023-12-12T14:32:50+05:30"
},
"seatingLocation": "5LC12",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "99501"
}
Get All Users
The Get All Users API can be used to get the details of all users in your account.
OAuth Scope : id360.user.READ,id360.user.ALL
Query Parameters
eg: firstName eq "John" and lastName eq "Doe"
eg: firstName,-lastName
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/users"
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/users")
.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/users', 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/users", 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/users",
"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/users \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": [
{
"city": "Anchorage",
"country": "US",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"firstName": "Alex",
"gender": "M",
"id": "2000000000001",
"isDomainVerified": false,
"language": "en",
"lastName": "Hales",
"mobileNumber": "7700900461",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"workLocation": "Alaska",
"zipPostal": "99501"
},
{
"city": "Los Angeles",
"country": "US",
"description": "User of sales department",
"displayName": "JohnRay",
"email": "johnray@company.com",
"employeeID": "13894",
"firstName": "John",
"gender": "M",
"id": "2000000000002",
"isDomainVerified": false,
"language": "en",
"lastName": "Raymond",
"mobileNumber": "7304729472",
"stateProvince": "California",
"status": 1,
"street": "Mckinley Ave, Los Angeled, California",
"workLocation": "California",
"zipPostal": "90001"
}
],
"meta": {
"cursor": null,
"next_cursor": null,
"is_last": true,
"limit": 100,
"total_no_of_objects": 2
}
}
{
"error": {
"code": "00000107",
"title": "Invalid Parameter",
"detail": "The parameter select is invalid."
}
}
{
"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."
}
}
Create User
The Create User API can be used to create a new user in your account.
OAuth Scope : id360.user.CREATE,id360.user.WRITE,id360.user.ALL
Arguments
- 1
- 0
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/users"
type: POST
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/users")
.post(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: 'POST',
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/users', 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("POST", "/api/v1/users", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/users",
"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 POST \
--url https://id360.manageengine.com/api/v1/users \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"city": "Anchorage",
"company": "Berge Corporation",
"country": "US",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"language": "en",
"lastName": "Hales",
"manager": "2000000072269",
"mobileNumber": "7700900461",
"password": "Test@1527#",
"postOfficeBox": "1052",
"seatingLocation": "5LC12",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "99501"
}
{
"data": {
"city": "Anchorage",
"company": "Berge Corporation",
"country": "US",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"id": "2000000000001",
"isDomainVerified": false,
"language": "en",
"lastName": "Hales",
"manager": "2000000072269",
"mobileNumber": "7700900461",
"postOfficeBox": "1052",
"primarySource": {
"applicationName": "Berge-Corp",
"applicationService": {
"name": "Universal Directory",
"id": "2000000018007",
"logo": "universal-directory",
"serviceName": "ZOHO_DIRECTORY"
},
"creationTime": "2023-12-12T14:32:50+05:30",
"isEnabled": true,
"id": "2000000072637",
"modifiedTime": "2023-12-12T14:32:50+05:30"
},
"seatingLocation": "5LC12",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "99501"
}
}
{
"error": {
"code": "00010111",
"title": "Template Validation Failed",
"detail": "Password does not meet password policy complexity requirements."
}
}
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00000102",
"title": "Unprocessable Content",
"detail": "An user with the Email id \"johnwick@jwcorp.com\" already exists. Please use a different Email id."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Get User
The Get User API can be used to get the details of a specific user in your account.
OAuth Scope : id360.user.READ,id360.user.ALL
Query Parameters
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/users/2000000000001"
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/users/2000000000001")
.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/users/2000000000001', 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/users/2000000000001", 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/users/2000000000001",
"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/users/2000000000001 \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": {
"city": "Anchorage",
"company": "Berge Corporation",
"country": "US",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"id": "2000000000001",
"isDomainVerified": false,
"language": "en",
"lastName": "Hales",
"manager": "2000000072269",
"mobileNumber": "7700900461",
"postOfficeBox": "1052",
"primarySource": {
"applicationName": "Berge-Corp",
"applicationService": {
"name": "Universal Directory",
"id": "2000000018007",
"logo": "universal-directory",
"serviceName": "ZOHO_DIRECTORY"
},
"creationTime": "2023-12-12T14:32:50+05:30",
"isEnabled": true,
"id": "2000000072637",
"modifiedTime": "2023-12-12T14:32:50+05:30"
},
"seatingLocation": "5LC12",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "99501"
}
}
{
"error": {
"code": "00000107",
"title": "Invalid Parameter",
"detail": "The parameter select is invalid."
}
}
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00010105",
"title": "User Not Found",
"detail": "This User ID does not exist or you do not have permission to access it."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Update User
The Update User API can be used to update the details of a specific user in your account.
OAuth Scope : id360.user.UPDATE,id360.user.WRITE,id360.user.ALL
Arguments
- 0
- 1
parameters_data='{"city":"Ottawa","company":"Berge Corporation","country":"CA","department":"Marketing","description":"User of marketing department","displayName":"Hales","email":"alexhales@company.com","employeeID":"12342","fax":"441619998888","firstName":"Alex","gender":"M","homePhone":"044-24681357","language":"en-CA","lastName":"Hales","manager":"2000000072271","mobileNumber":"7700900461","password":"Test@1527#","postOfficeBox":"1052","seatingLocation":"5LC12","stateProvince":"Ontario","status":1,"street":"Colonel Murray St, Ottawa, Ontario","telephoneNumber":"9072746922","title":"Manager","workLocation":"Alaska","zipPostal":"K0A0A4"}';
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/users/2000000000001"
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, "{\"city\":\"Ottawa\",\"company\":\"Berge Corporation\",\"country\":\"CA\",\"department\":\"Marketing\",\"description\":\"User of marketing department\",\"displayName\":\"Hales\",\"email\":\"alexhales@company.com\",\"employeeID\":\"12342\",\"fax\":\"441619998888\",\"firstName\":\"Alex\",\"gender\":\"M\",\"homePhone\":\"044-24681357\",\"language\":\"en-CA\",\"lastName\":\"Hales\",\"manager\":\"2000000072271\",\"mobileNumber\":\"7700900461\",\"password\":\"Test@1527#\",\"postOfficeBox\":\"1052\",\"seatingLocation\":\"5LC12\",\"stateProvince\":\"Ontario\",\"status\":1,\"street\":\"Colonel Murray St, Ottawa, Ontario\",\"telephoneNumber\":\"9072746922\",\"title\":\"Manager\",\"workLocation\":\"Alaska\",\"zipPostal\":\"K0A0A4\"}");
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/users/2000000000001")
.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: '{"city":"Ottawa","company":"Berge Corporation","country":"CA","department":"Marketing","description":"User of marketing department","displayName":"Hales","email":"alexhales@company.com","employeeID":"12342","fax":"441619998888","firstName":"Alex","gender":"M","homePhone":"044-24681357","language":"en-CA","lastName":"Hales","manager":"2000000072271","mobileNumber":"7700900461","password":"Test@1527#","postOfficeBox":"1052","seatingLocation":"5LC12","stateProvince":"Ontario","status":1,"street":"Colonel Murray St, Ottawa, Ontario","telephoneNumber":"9072746922","title":"Manager","workLocation":"Alaska","zipPostal":"K0A0A4"}'
};
fetch('https://id360.manageengine.com/api/v1/users/2000000000001', 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 = "{\"city\":\"Ottawa\",\"company\":\"Berge Corporation\",\"country\":\"CA\",\"department\":\"Marketing\",\"description\":\"User of marketing department\",\"displayName\":\"Hales\",\"email\":\"alexhales@company.com\",\"employeeID\":\"12342\",\"fax\":\"441619998888\",\"firstName\":\"Alex\",\"gender\":\"M\",\"homePhone\":\"044-24681357\",\"language\":\"en-CA\",\"lastName\":\"Hales\",\"manager\":\"2000000072271\",\"mobileNumber\":\"7700900461\",\"password\":\"Test@1527#\",\"postOfficeBox\":\"1052\",\"seatingLocation\":\"5LC12\",\"stateProvince\":\"Ontario\",\"status\":1,\"street\":\"Colonel Murray St, Ottawa, Ontario\",\"telephoneNumber\":\"9072746922\",\"title\":\"Manager\",\"workLocation\":\"Alaska\",\"zipPostal\":\"K0A0A4\"}"
headers = {
'Accept': "application/json",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PATCH", "/api/v1/users/2000000000001", 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/users/2000000000001",
"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({
city: 'Ottawa',
company: 'Berge Corporation',
country: 'CA',
department: 'Marketing',
description: 'User of marketing department',
displayName: 'Hales',
email: 'alexhales@company.com',
employeeID: '12342',
fax: '441619998888',
firstName: 'Alex',
gender: 'M',
homePhone: '044-24681357',
language: 'en-CA',
lastName: 'Hales',
manager: '2000000072271',
mobileNumber: '7700900461',
password: 'Test@1527#',
postOfficeBox: '1052',
seatingLocation: '5LC12',
stateProvince: 'Ontario',
status: 1,
street: 'Colonel Murray St, Ottawa, Ontario',
telephoneNumber: '9072746922',
title: 'Manager',
workLocation: 'Alaska',
zipPostal: 'K0A0A4'
}));
req.end();
curl --request PATCH \
--url https://id360.manageengine.com/api/v1/users/2000000000001 \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"city":"Ottawa","company":"Berge Corporation","country":"CA","department":"Marketing","description":"User of marketing department","displayName":"Hales","email":"alexhales@company.com","employeeID":"12342","fax":"441619998888","firstName":"Alex","gender":"M","homePhone":"044-24681357","language":"en-CA","lastName":"Hales","manager":"2000000072271","mobileNumber":"7700900461","password":"Test@1527#","postOfficeBox":"1052","seatingLocation":"5LC12","stateProvince":"Ontario","status":1,"street":"Colonel Murray St, Ottawa, Ontario","telephoneNumber":"9072746922","title":"Manager","workLocation":"Alaska","zipPostal":"K0A0A4"}'
{
"city": "Ottawa",
"company": "Berge Corporation",
"country": "CA",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "Hales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"language": "en-CA",
"lastName": "Hales",
"manager": "2000000072271",
"mobileNumber": "7700900461",
"password": "Test@1527#",
"postOfficeBox": "1052",
"seatingLocation": "5LC12",
"stateProvince": "Ontario",
"status": 1,
"street": "Colonel Murray St, Ottawa, Ontario",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "K0A0A4"
}
{
"data": {
"city": "Ottawa",
"company": "Berge Corporation",
"country": "CA",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "Hales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"id": "2000000000001",
"isDomainVerified": false,
"language": "en-CA",
"lastName": "Hales",
"manager": "2000000072271",
"mobileNumber": "7700900461",
"postOfficeBox": "1052",
"primarySource": {
"applicationName": "Berge-Corp",
"applicationService": {
"name": "Universal Directory",
"id": "2000000018007",
"logo": "universal-directory",
"serviceName": "ZOHO_DIRECTORY"
},
"creationTime": "2023-12-12T14:32:50+05:30",
"isEnabled": true,
"id": "2000000072637",
"modifiedTime": "2023-12-12T14:32:50+05:30"
},
"seatingLocation": "5LC12",
"stateProvince": "Ontario",
"status": 1,
"street": "Colonel Murray St, Ottawa, Ontario",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "K0A0A4"
}
}
{
"error": {
"code": "00010111",
"title": "Template Validation Failed",
"detail": "Password does not meet password policy complexity requirements."
}
}
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00010109",
"title": "Unlicensed User",
"detail": "Actions cannot be performed on unlicensed users."
}
}
{
"error": {
"code": "00010105",
"title": "User Not Found",
"detail": "This User ID does not exist or you do not have permission to access it."
}
}
{
"error": {
"code": "00000102",
"title": "Unprocessable Content",
"detail": "Password should not be same as your last 1 password(s)"
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Delete User
Delete User API can be used to delete a specific user in your account.
OAuth Scope : id360.user.DELETE,id360.user.WRITE,id360.user.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/users/2000000000001"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/users/2000000000001")
.delete(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/users/2000000000001', 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("DELETE", "/api/v1/users/2000000000001", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/users/2000000000001",
"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 DELETE \
--url https://id360.manageengine.com/api/v1/users/2000000000001 \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00010109",
"title": "Unlicensed User",
"detail": "Actions cannot be performed on unlicensed users."
}
}
{
"error": {
"code": "00010105",
"title": "User Not Found",
"detail": "This User ID does not exist or you do not have permission to access it."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Enable User
Enable User API can be used to enable a specific user in your account.
OAuth Scope : id360.user.UPDATE,id360.user.WRITE,id360.user.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/users/2000000000001/enable"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/users/2000000000001/enable")
.post(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/users/2000000000001/enable', 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("POST", "/api/v1/users/2000000000001/enable", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/users/2000000000001/enable",
"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 POST \
--url https://id360.manageengine.com/api/v1/users/2000000000001/enable \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00010109",
"title": "Unlicensed User",
"detail": "Actions cannot be performed on unlicensed users."
}
}
{
"error": {
"code": "00010105",
"title": "User Not Found",
"detail": "This User ID does not exist or you do not have permission to access it."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Disable User
Disable User API can be used to disable a specific user in your account.
OAuth Scope : id360.user.UPDATE,id360.user.WRITE,id360.user.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/users/2000000000001/disable"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/users/2000000000001/disable")
.post(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/users/2000000000001/disable', 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("POST", "/api/v1/users/2000000000001/disable", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/users/2000000000001/disable",
"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 POST \
--url https://id360.manageengine.com/api/v1/users/2000000000001/disable \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00010109",
"title": "Unlicensed User",
"detail": "Actions cannot be performed on unlicensed users."
}
}
{
"error": {
"code": "00010105",
"title": "User Not Found",
"detail": "This User ID does not exist or you do not have permission to access it."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Create User using template
The Create user using template API can be used to create a new user in your account using the provided template.
OAuth Scope : id360.user.CREATE,id360.user.WRITE,id360.user.ALL
Arguments
- 1
- 0
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/users/new/2000000000101"
type: POST
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/users/new/2000000000101")
.post(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: 'POST',
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/users/new/2000000000101', 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("POST", "/api/v1/users/new/2000000000101", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/users/new/2000000000101",
"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 POST \
--url https://id360.manageengine.com/api/v1/users/new/2000000000101 \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"city": "Anchorage",
"company": "Berge Corporation",
"country": "US",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"language": "en",
"lastName": "Hales",
"manager": "2000000072269",
"mobileNumber": "7700900461",
"password": "Test@1527#",
"postOfficeBox": "1052",
"seatingLocation": "5LC12",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "99501"
}
{
"data": {
"city": "Anchorage",
"company": "Berge Corporation",
"country": "US",
"department": "Marketing",
"description": "User of marketing department",
"displayName": "AlexHales",
"email": "alexhales@company.com",
"employeeID": "12342",
"fax": "441619998888",
"firstName": "Alex",
"gender": "M",
"homePhone": "044-24681357",
"id": "2000000000001",
"isDomainVerified": false,
"language": "en",
"lastName": "Hales",
"manager": "2000000072269",
"mobileNumber": "7700900461",
"postOfficeBox": "1052",
"primarySource": {
"applicationName": "Berge-Corp",
"applicationService": {
"name": "Universal Directory",
"id": "2000000018007",
"logo": "universal-directory",
"serviceName": "ZOHO_DIRECTORY"
},
"creationTime": "2023-12-12T14:32:50+05:30",
"isEnabled": true,
"id": "2000000072637",
"modifiedTime": "2023-12-12T14:32:50+05:30"
},
"seatingLocation": "5LC12",
"stateProvince": "Alaska",
"status": 1,
"street": "19th Ave, Anchorage, Alaska",
"telephoneNumber": "9072746922",
"title": "Manager",
"workLocation": "Alaska",
"zipPostal": "99501"
}
}
{
"error": {
"code": "00010111",
"title": "Template Validation Failed",
"detail": "Password does not meet password policy complexity requirements."
}
}
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00010112",
"title": "Template Not Found",
"detail": "No templates found or the provided template ID does not match the directory."
}
}
{
"error": {
"code": "00000102",
"title": "Unprocessable Content",
"detail": "An user with the Email id \"johnwick@jwcorp.com\" already exists. Please use a different Email id."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}