Accounts

This API Document describes the APIs for local accounts on devices in Identity360.

Download Accounts OpenAPI Document

End Points

GET

/devices/{device_id}/accounts

POST

/devices/{device_id}/accounts/{account_id}/link

POST

/devices/{device_id}/accounts/{account_id}/cancel-link

POST

/devices/{device_id}/accounts/{account_id}/unlink

GET

/devices/{device_id}/link-restricted-users

DELETE

/devices/{device_id}/link-restricted-users

Attribute

integer

Unique identifier for the device local account.

user_name

string

Local account name associated with the device.

permission_level

string

Permission level of the device account.

Allowed Values:

Standard
Administrator

last_login

date-time

Last login time of the device account.

is_idp_linked

boolean

Indicates if the device account is linked to an Identity Provider (IdP).

idp_user_id

string

Unique identifier for the user in the IdP.

idp_user_details

object

Details of the linked IdP account.

Show Sub-Attributes

user_id

integer

Unique identifier for the user in the IdP.

user_name

string

Username of the IdP account.

display_name

string

Display name of the IdP account.

link_type

string

Type of link between the device account and IdP.

link_status

string

Status of the link between the device account and IdP.

linked_at

date-time

Timestamp when the device account was linked to the IdP.

{
    "id": 2000000000001,
    "user_name": "john.doe",
    "permission_level": "Standard",
    "last_login": "2023-10-01T12:00:00Z",
    "is_idp_linked": true,
    "idp_user_id": "2000000000011",
    "idp_user_details": {
        "user_id": 2000000000011,
        "user_name": "johndoe@mydomain.com",
        "display_name": "John Doe",
        "link_type": "Manual",
        "link_status": "pending_link",
        "linked_at": "2023-10-01T12:00:00Z"
    }
}

List Device Local Accounts

The List Devices Local Accounts API allows you to fetch the list of local accounts associated with a device.
OAuth Scope : id360.device.READ,id360.device.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

Request Example

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

{
    "data": [
        {
            "id": 2000000000001,
            "user_name": "Johnson",
            "permission_level": "Admin",
            "last_login": null,
            "is_idp_linked": false
        },
        {
            "id": 2000000000002,
            "user_name": "Mike",
            "permission_level": "Standard",
            "last_login": "2023-10-26T03:30:00Z",
            "is_idp_linked": true,
            "idp_account_details": {
                "user_id": 2000000000011,
                "user_name": "Mike@mydomain.com",
                "display_name": "Mike",
                "link_type": "Manual",
                "link_status": "linked",
                "linked_at": "2023-10-26T03:30:00Z"
            }
        },
        {
            "id": 2000000000003,
            "user_name": "Dani",
            "permission_level": "Admin",
            "last_login": null,
            "is_idp_linked": false
        },
        {
            "id": 2000000000004,
            "user_name": "Rose",
            "permission_level": "Standard",
            "last_login": "2023-10-26T03:30:00Z",
            "is_idp_linked": true,
            "idp_account_details": {
                "user_id": 2000000000012,
                "user_name": "Capt@mydomain.com",
                "display_name": "Capt",
                "link_type": "Automatic",
                "link_status": "linked",
                "linked_at": "2023-10-26T03:30:00Z"
            }
        }
    ],
    "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."
    }
}

Link Device Local Account to IdP

The Link Device Local Account to IdP API allows you to link a local account on a device to an Identity Provider (IdP).
OAuth Scope : id360.device.write,id360.device.all

Arguments

permission_level

string

Permission level of the device account.

Allowed Values:

Standard
Administrator

idp_user_id

string

Unique identifier for the user in the IdP.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/link"
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/devices/987000000654321/accounts/987000000654321/link")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/link', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/devices/987000000654321/accounts/987000000654321/link", 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/devices/987000000654321/accounts/987000000654321/link",
  "headers": {
    "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/devices/987000000654321/accounts/987000000654321/link \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "permission_level": "Standard",
    "idp_user_id": "2000000000011"
}

Response Example

{
    "data": {
        "id": "2000000293042",
        "status": "RUNNING",
        "message": "Process is initiated, check jobs for current status."
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Access Denied",
        "detail": "You do not have permission to do this operation."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Cancel Link of Device Local Account to IdP

The Cancel Link of Device Local Account to IdP API allows you to cancel the link between a local account on a device and an Identity Provider (IdP).
OAuth Scope : id360.device.write,id360.device.all

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/cancel-link"
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/devices/987000000654321/accounts/987000000654321/cancel-link")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/cancel-link', 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("POST", "/api/v1/devices/987000000654321/accounts/987000000654321/cancel-link", 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/devices/987000000654321/accounts/987000000654321/cancel-link",
  "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 POST \
  --url https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/cancel-link \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "********",
        "title": "Account is linked",
        "detail": "The account is already linked and cannot be canceled. Please use the unlink action instead."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Unlink Device Local Account from IdP

The Unlink Device Local Account from IdP API allows you to unlink a local account on a device from IdP.
OAuth Scope : id360.device.write,id360.device.all

Arguments

type

string

Type of unlink operation to be performed.

Allowed Values:

unlink_and_change_password
unlink_and_suspend

new_password

string

New password to be set for the device local account. Only required if type is 'unlink_and_change_password'.

restrict_relink_for_idp_account

boolean

Restrict re-linking of the IdP account to the device local account after unlinking.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/unlink"
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/devices/987000000654321/accounts/987000000654321/unlink")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://id360.manageengine.com/api/v1/devices/987000000654321/accounts/987000000654321/unlink', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/devices/987000000654321/accounts/987000000654321/unlink", 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/devices/987000000654321/accounts/987000000654321/unlink",
  "headers": {
    "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/devices/987000000654321/accounts/987000000654321/unlink \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "type": "unlink_and_change_password",
    "new_password": "S3cure@123",
    "restrict_relink_for_idp_account": false
}

Response Example

{
    "data": {
        "id": "2000000293042",
        "status": "RUNNING",
        "message": "Process is initiated, check jobs for current status."
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "********",
        "title": "Missing required field",
        "detail": "The parameter new_password is required"
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

List Link Restricted Users

The List Link Restricted Users API allows you to fetch the list of users who are restricted from linking to a device.
OAuth Scope : id360.device.read,id360.device.all

Query Parameters

limit

Limit the number of users to be fetched

from

Start index for pagination.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/devices/987000000654321/link-restricted-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/devices/987000000654321/link-restricted-users")
  .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/devices/987000000654321/link-restricted-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 = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v1/devices/987000000654321/link-restricted-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/devices/987000000654321/link-restricted-users",
  "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/devices/987000000654321/link-restricted-users \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        [
            {
                "id": "2000000000011",
                "display_name": "AlexHales",
                "user_name": "alexhales@company.com",
                "unlinked_time": "2024-07-15T14:20:00Z",
                "primary_source": {
                    "id": "2000000072637",
                    "name": "Berge-Corp",
                    "application_service": {
                        "id": "2000000018007",
                        "display_name": "Universal Directory",
                        "name": "ZOHO_DIRECTORY",
                        "logo": "universal-directory"
                    }
                }
            },
            {
                "id": "2000000000012",
                "display_name": "JohnDoe",
                "user_name": "johndoe@company.com",
                "unlinked_time": "2024-07-16T09:30:00Z",
                "primary_source": {
                    "id": "2000000072637",
                    "name": "Berge-Corp",
                    "application_service": {
                        "id": "2000000018007",
                        "display_name": "Universal Directory",
                        "name": "ZOHO_DIRECTORY",
                        "logo": "universal-directory"
                    }
                }
            },
            {
                "id": "2000000000013",
                "display_name": "JaneSmith",
                "user_name": "janesmith@company.com",
                "unlinked_time": "2024-07-17T15:45:00Z",
                "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."
    }
}

Unrestrict Link Restricted Users

The Unrestrict Link Restricted Users API allows you to remove the restriction on users who are restricted from linking to a device.
OAuth Scope : id360.device.write,id360.device.delete,id360.device.all

Query Parameters

ids

(Required)

Comma-separated list of resource IDs.
eg: 2000000000011,2000000000012

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/devices/987000000654321/link-restricted-users?ids=2000000000011,2000000000012"
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/devices/987000000654321/link-restricted-users?ids=2000000000011%2C2000000000012")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/devices/987000000654321/link-restricted-users?ids=2000000000011%2C2000000000012', 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("DELETE", "/api/v1/devices/987000000654321/link-restricted-users?ids=2000000000011%2C2000000000012", 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/devices/987000000654321/link-restricted-users?ids=2000000000011%2C2000000000012",
  "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 DELETE \
  --url 'https://id360.manageengine.com/api/v1/devices/987000000654321/link-restricted-users?ids=2000000000011%2C2000000000012' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}