Templates
This is a template for APIs Documentation
Download Templates OpenAPI Document
End Points
Get User Creation Template
Attribute
id
string
Unique identifier for the user creation template
name
string
Name of the user creation template
description
string
Description of the user creation template
category
string
Category of the user creation template
isDefault
boolean
Indicates if the template is a default template
isUserDefined
boolean
Indicates if the template is user-defined
isMultiDirTemplate
boolean
Indicates if the template is a multi-directory template
createdTime
string
Time when the template was created
lastModifiedTime
string
Time when the template was last modified
directories
array
List of directories associated with the template
id
string
Unique identifier for the directory
name
string
Name of the directory
isMandatory
boolean
Indicates if the directory is mandatory for the template
isPrimary
boolean
Indicates if the directory is the primary directory for the template
{
"id": "2000000066609",
"name": "User Creation System Template",
"description": "User creation template",
"category": "General",
"isDefault": true,
"isUserDefined": false,
"isMultiDirTemplate": false,
"createdTime": "2024-05-10T21:16:41+05:30",
"lastModifiedTime": "2024-05-14T19:19:41+05:30",
"directories": [
{
"id": "2000000174051",
"name": "PrimeTech Solutions",
"isMandatory": false,
"isPrimary": true
}
]
}
Get User Creation Template
The Get User Creation Template API can be used to get the template for creating a new user in your account.
OAuth Scope : id360.template.user.read
Query Parameters
from
Start range of the response
limit
Number of user creation templates to be returned in the response
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/templates/users/creation"
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/templates/users/creation")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/templates/users/creation', 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 = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/api/v1/templates/users/creation", 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/templates/users/creation",
"headers": {
"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/templates/users/creation \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": [
{
"id": "2000000066609",
"name": "User Creation System Template",
"description": "User creation template",
"category": "General",
"isDefault": true,
"isUserDefined": false,
"isMultiDirTemplate": true,
"createdTime": "-",
"lastModifiedTime": "-",
"directories": [
{
"name": "PrimeTech Solutions",
"id": "2000000174051",
"isMandatory": false
},
{
"name": "primetechsolution.onmicrosoft.com",
"id": "2000000082077",
"isMandatory": false
},
{
"name": "primetechcloud.onmicrosoft.com",
"id": "2000000156075",
"isMandatory": false
},
{
"name": "PrimeTech",
"id": "2000000076385",
"isMandatory": false
}
]
},
{
"id": "2000000077228",
"name": "PrimeTech Zoho primary user creation template",
"description": "Zoho directory primary User creation template",
"category": "General",
"isDefault": false,
"isUserDefined": true,
"isMultiDirTemplate": true,
"createdTime": "2024-05-10T21:16:41+05:30",
"lastModifiedTime": "2024-05-14T19:19:41+05:30",
"directories": [
{
"name": "primetechsolution.onmicrosoft.com",
"id": "2000000082077",
"isMandatory": false
},
{
"name": "PrimeTech Solutions",
"id": "2000000174051",
"isMandatory": false
},
{
"isPrimary": true,
"name": "PrimeTec",
"id": "2000000076385",
"isMandatory": true
}
]
},
{
"id": "2000000401001",
"name": "PrimeTech cloud(AAD) and multiple directory User Creation Template",
"description": "User creation template with AAD(primetechcloud) as Primnary directory Template and multiple mandate directory",
"category": "General",
"isDefault": false,
"isUserDefined": true,
"isMultiDirTemplate": true,
"createdTime": "2024-05-14T19:32:38+05:30",
"lastModifiedTime": "2024-05-14T19:33:06+05:30",
"directories": [
{
"isPrimary": true,
"name": "primetechcloud.onmicrosoft.com",
"id": "2000000156075",
"isMandatory": true
},
{
"name": "PrimeTech Solutions",
"id": "2000000174051",
"isMandatory": true
},
{
"name": "PrimeTech",
"id": "2000000076385",
"isMandatory": true
}
]
},
{
"id": "2000000402001",
"name": "PrimeTech Solution AAD User creation Template ",
"description": "User creation template with AAD(PrimeTechSolution) as Primnary directory for creation",
"category": "General",
"isDefault": false,
"isUserDefined": true,
"isMultiDirTemplate": true,
"createdTime": "2024-05-14T19:40:21+05:30",
"lastModifiedTime": "-",
"directories": [
{
"isPrimary": true,
"name": "primetechsolution.onmicrosoft.com",
"id": "2000000156077",
"isMandatory": true
},
{
"name": "PrimeTech Solutions",
"id": "2000000174051",
"isMandatory": false
},
{
"name": "PrimeTech",
"id": "2000000076385",
"isMandatory": false
}
]
},
{
"id": "2000000402997",
"name": "SF PrimeTech Solution Template",
"description": "SalesForce User creation template",
"category": "General",
"isDefault": false,
"isUserDefined": true,
"isMultiDirTemplate": false,
"createdTime": "2024-05-14T19:40:54+05:30",
"lastModifiedTime": "-",
"directories": [
{
"isPrimary": true,
"name": "PrimeTech Solutions",
"id": "2000000174051",
"isMandatory": true
}
]
},
{
"id": "2000000074609",
"name": "Google User Creation Template",
"description": "User creation template",
"category": null,
"isDefault": true,
"isUserDefined": false,
"isMultiDirTemplate": false,
"createdTime": "-",
"lastModifiedTime": "-",
"directories": []
},
{
"id": "2000000074771",
"name": "Velpic User Creation Template",
"description": "User creation template",
"category": null,
"isDefault": true,
"isUserDefined": false,
"isMultiDirTemplate": false,
"createdTime": "-",
"lastModifiedTime": "-",
"directories": []
}
],
"meta": {
"start_index": "1",
"limit": 200,
"total_no_of_objects": 7
}
}
{
"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."
}
}