API Docs - For Review
/
No Results Found
Group

Group

Group API for ManageEngine ID360

Download Group OpenAPI Document
End Points

Attribute

id
string
The unique identifier for the group, assigned by the system.
name
string
The name of the group.
description
string
A brief description of the group.
members_count
integer
The number of members in the group.
when_created
date-time
The timestamp when the group was created, in ISO 8601 format.
is_dynamic
boolean
Indicates whether the group is dynamic or static.
primary_source
object
Details about the primary directory of the group.
Show Sub-Attributes arrow
id
string
The unique identifier for the directory.
name
string
The name of the application or directory.
application_service
object
Details about the service associated with the directory or app.
Show Sub-Attributes arrow
id
string
The unique identifier for the application service.
display_name
string
Application Service Name
name
string
Service Name
members
array
List of members in the group.

Example

{ "id": "2000000106686", "name": "Group", "description": "Default group for all users", "members_count": 5, "when_created": "2024-05-07T10:36:27+05:30", "is_dynamic": false, "primary_source": { "id": "2000000072637", "name": "Berge-Corp", "application_service": { "id": "2000000018007", "display_name": "Universal Directory", "name": "ZOHO_DIRECTORY", "logo": "universal-directory" } }, "members": [ "2000000108825", "2000000108623", "2000000108895", "2000000105735", "2000000108791" ] }

List Groups

The List Groups API can be used to get a list of all groups in your account.
OAuth Scope : id360.group.READ,id360.group.ALL

Query Parameters

limit
Limit the number of users to be fetched
fields
Select the fields to be fetched in the response.
filter
Filter users based on a the provided SCIM filter query. Refer to filter section for more details
eg: firstName eq "John" and lastName eq "Doe"
sort
Sort the users based on the provided field. The default sort order is ascending. To sort in descending order, prefix the field with a - (hyphen).
eg: firstName,-lastName
cursor
Cursor for pagination. Use the next_cursor value from the previous response to fetch the next set of results.

Request Example

Click to copy
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/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/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/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/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/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/groups \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "data": [ { "id": "2000000106686", "name": "Group 1", "description": "Default group for all users", "members_count": 5, "when_created": "2024-05-07T10:36:27+05:30", "is_dynamic": false, "primary_source": { "id": "2000000072637", "name": "Berge-Corp", "application_service": { "id": "2000000018007", "display_name": "Universal Directory", "name": "ZOHO_DIRECTORY", "logo": "universal-directory" } }, "members": [ "2000000108825", "2000000108623", "2000000108895", "2000000105735", "2000000108791" ] }, { "id": "2000000106687", "name": "Group 2", "description": "Group for Test Team", "members_count": 3, "when_created": "2024-05-08T11:00:00+05:30", "is_dynamic": true, "primary_source": { "id": "2000000072638", "name": "Berge-Corp", "application_service": { "id": "2000000018008", "display_name": "Universal Directory", "name": "ZOHO_DIRECTORY", "logo": "universal-directory" } }, "members": [ "2000000108826", "2000000108624", "2000000108896" ] } ], "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 Group

The Create Group API can be used to create a new group in your account.
OAuth Scope : id360.group.CREATE,id360.group.WRITE,id360.group.ALL

Arguments

name
string
The name of the group.
description
string
A brief description of the group.
is_dynamic
boolean
Indicates whether the group is dynamic or static.
members
array
List of members in the group.

Request Example

Click to copy
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/groups" 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/groups") .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/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") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/api/v1/groups", 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/groups", "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/groups \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "name": "Group", "description": "Default group for all users", "is_dynamic": false, "members": [ "2000000108825", "2000000108623", "2000000108895", "2000000105735", "2000000108791" ] }

Response Example

{ "data": { "id": "2000000106686", "name": "Group", "description": "Default group for all users", "members_count": 5, "when_created": "2024-05-07T10:36:27+05:30", "is_dynamic": false, "primary_source": { "id": "2000000072637", "name": "Berge-Corp", "application_service": { "id": "2000000018007", "display_name": "Universal Directory", "name": "ZOHO_DIRECTORY", "logo": "universal-directory" } } } }
{ "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 Group

The Get Group API can be used to fetch the details of a specific group in your account.
OAuth Scope : id360.group.READ,id360.group.ALL

Query Parameters

fields
Select the fields to be fetched in the response.

Request Example

Click to copy
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/groups/987000000654321" 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/groups/987000000654321") .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/groups/987000000654321', 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/groups/987000000654321", 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/groups/987000000654321", "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/groups/987000000654321 \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "data": { "id": "2000000106686", "name": "Group", "description": "Default group for all users", "members_count": 5, "when_created": "2024-05-07T10:36:27+05:30", "is_dynamic": false, "primary_source": { "id": "2000000072637", "name": "Berge-Corp", "application_service": { "id": "2000000018007", "display_name": "Universal Directory", "name": "ZOHO_DIRECTORY", "logo": "universal-directory" } } } }
{ "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": "*****", "title": "Resource Not Found", "detail": "This Group does not exist." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Update Group

The Update Group API can be used to update the details of a specific group in your account.
OAuth Scope : id360.group.UPDATE,id360.group.WRITE,id360.group.ALL

Arguments

name
string
The name of the group.
description
string
A brief description of the group.
is_dynamic
boolean
Indicates whether the group is dynamic or static.
members
array
List of members in the group.

Request Example

Click to copy
parameters_data='{"name":"Group","description":"Default group for all users","is_dynamic":false,"members":["2000000108825","2000000108623","2000000108895","2000000105735","2000000108791"]}'; 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/groups/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, "{\"name\":\"Group\",\"description\":\"Default group for all users\",\"is_dynamic\":false,\"members\":[\"2000000108825\",\"2000000108623\",\"2000000108895\",\"2000000105735\",\"2000000108791\"]}"); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/groups/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: '{"name":"Group","description":"Default group for all users","is_dynamic":false,"members":["2000000108825","2000000108623","2000000108895","2000000105735","2000000108791"]}' }; fetch('https://id360.manageengine.com/api/v1/groups/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 = "{\"name\":\"Group\",\"description\":\"Default group for all users\",\"is_dynamic\":false,\"members\":[\"2000000108825\",\"2000000108623\",\"2000000108895\",\"2000000105735\",\"2000000108791\"]}" headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PATCH", "/api/v1/groups/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/groups/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({ name: 'Group', description: 'Default group for all users', is_dynamic: false, members: [ '2000000108825', '2000000108623', '2000000108895', '2000000105735', '2000000108791' ] })); req.end();
curl --request PATCH \ --url https://id360.manageengine.com/api/v1/groups/2000000000001 \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"name":"Group","description":"Default group for all users","is_dynamic":false,"members":["2000000108825","2000000108623","2000000108895","2000000105735","2000000108791"]}'

Body Parameters

Click to copy
{ "name": "Group", "description": "Default group for all users", "is_dynamic": false, "members": [ "2000000108825", "2000000108623", "2000000108895", "2000000105735", "2000000108791" ] }

Response Example

{ "data": { "id": "2000000106686", "name": "Group", "description": "Default group for all users", "members_count": 5, "when_created": "2024-05-07T10:36:27+05:30", "is_dynamic": false, "primary_source": { "id": "2000000072637", "name": "Berge-Corp", "application_service": { "id": "2000000018007", "display_name": "Universal Directory", "name": "ZOHO_DIRECTORY", "logo": "universal-directory" } } } }
{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "*****", "title": "Resource Not Found", "detail": "This Group does not exist." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Delete Group

The Delete Group API can be used to delete a specific group in your account.
OAuth Scope : id360.group.DELETE,id360.group.WRITE,id360.group.ALL

Request Example

Click to copy
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/groups/987000000654321" 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/groups/987000000654321") .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/groups/987000000654321', 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/groups/987000000654321", 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/groups/987000000654321", "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/groups/987000000654321 \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "*****", "title": "Resource Not Found", "detail": "This Group does not exist." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }