Template APIs

Get user creation templates

Use this API to get the list of user creation templates: |
GET https://id360.manageengine.com/api/v1/templates/users/creation

Parameters

from number Start index
limit number Total number of templates to be obtained. By default, it's 200, and the maximum limit is also 200.

Scopes - idmpod.user.ALL & idmpod.user.READ

Response

Success

Response Code - 200

{
	"data": [
		{
			"isDefault": true,
			"lastModifiedTime": "-",
			"name": "User Creation System Template",
			"description": "User creation template",
			"createdTime": "-",
			"isUserDefined": false,
			"id": "3000000066609",
			"category": "General",
			"isMultiDirTemplate": true,
			"directories": [
				{
					"name": "PrimeTech Solutions",
					"id": "3000000174051",
					"isMandatory": false
				},
				{
					"name": "primetechsolution.onmicrosoft.com",
					"id": "3000000082077",
					"isMandatory": false
				},
				{
					"name": "primetechcloud.onmicrosoft.com",
					"id": "3000000156075",
					"isMandatory": false
				},
				{
					"name": "PrimeTech",
					"id": "3000000076385",
					"isMandatory": false
				}
			]
		},
		{
			"isDefault": false,
			"lastModifiedTime": "2024-05-14T19:19:41+05:30",
			"name": "PrimeTech Zoho primary user creation template",
			"description": "Zoho directory primary User creation template",
			"createdTime": "2024-05-10T21:16:41+05:30",
			"isUserDefined": true,
			"id": "3000000077228",
			"category": "General",
			"isMultiDirTemplate": true,
			"directories": [
				{
					"name": "primetechsolution.onmicrosoft.com",
					"id": "2000000082077",
					"isMandatory": false
				},
				{
					"name": "PrimeTech Solutions",
					"id": "2000000174051",
					"isMandatory": false
				},
				{
					"isPrimary": true,
					"name": ""PrimeTec",
					"id": "2000000076385",
					"isMandatory": true
				}
			]
		},
		{
			"isDefault": false,
			"lastModifiedTime": "2024-05-14T19:33:06+05:30",
			"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",
			"createdTime": "2024-05-14T19:32:38+05:30",
			"isUserDefined": true,
			"id": "3000000401001",
			"category": "General",
			"isMultiDirTemplate": true,
			"directories": [
				{
					"isPrimary": true,
					"name": "primetechcloud.onmicrosoft.com",
					"id": "2000000156075",
					"isMandatory": true
				},
				{
					"name": "PrimeTech Solutions",
					"id": "2000000174051",
					"isMandatory": true
				},
				{
					"name": ""PrimeTech",
					"id": "2000000076385",
					"isMandatory": true
				}
			]
		},
		{
			"isDefault": false,
			"lastModifiedTime": "-",
			"name": "PrimeTech Solution AAD User creation Template ",
			"description": "User creation template with AAD(PrimeTechSolution) as Primnary directory for creation",
			"createdTime": "2024-05-14T19:40:21+05:30",
			"isUserDefined": true,
			"id": "3000000402001",
			"category": "General",
			"isMultiDirTemplate": true,
			"directories": [
				{
					"isPrimary": true,
					"name": "primetechsolution.onmicrosoft.com",
					"id": "2000000156077",
					"isMandatory": true
				},
				{
					"name": "PrimeTech Solutions",
					"id": "2000000174051",
					"isMandatory": false
				},
				{
					"name": "PrimeTech",
					"id": "2000000076385",
					"isMandatory": false
				}
			]
		},
		{
			"isDefault": false,
			"lastModifiedTime": "-",
			"name": "SF PrimeTech Solution Template",
			"description": "SalesForce User creation template",
			"createdTime": "2024-05-14T19:40:54+05:30",
			"isUserDefined": true,
			"id": "3000000402997",
			"category": "General",
			"isMultiDirTemplate": false,
			"directories": [
				{
					"isPrimary": true,
					"name": "PrimeTech Solutions",
					"id": "2000000174051",
					"isMandatory": true
				}
			]
		},
		{
			"isDefault": true,
			"lastModifiedTime": "-",
			"name": "Google User Creation Template",
			"description": "User creation template",
			"createdTime": "-",
			"isUserDefined": false,
			"id": "3000000074609",
			"category": null,
			"isMultiDirTemplate": false,
			"directories": []
		},
		{
			"isDefault": true,
			"lastModifiedTime": "-",
			"name": "Velpic User Creation Template",
			"description": "User creation template",
			"createdTime": "-",
			"isUserDefined": false,
			"id": "3000000074771",
			"category": null,
			"isMultiDirTemplate": false,
			"directories": [],
		}
	],
	"meta": {
		"start_index": 1,
		"limit": 200,
		"total_no_of_objects": 7
	}
}

Failure

Response code - <error-response-code>

{
	"error": {
	   "code": <error-code>,
	   "detail": <error-detail>,
	   "title": <error-title>
   }
}

Copyright © 2024, ZOHO Corp. All Rights Reserved.