Skip to content

User

No Description

Attributes

id (long)
Unique user identity.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

first_name (string)
First name of the user.

first_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

middle_name (string)
Middle name of the user.

middle_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

last_name (string)
Last name of the user.

last_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

name (string)
Name of the user.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

employee_id (string)
Unique employee id assigned to the user.

employee_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

More Attributes Expand all

email_id (string)

Email address of the user.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

secondary_emailids (string)

Secondary email addresses of the user.

secondary_emailids (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

phone (string)

Phone number of the user.

phone (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile number of the user.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

purchase_approval_limit (double)

Amount up to which purchase order approval is permitted for the user.

purchase_approval_limit (double)
These are numbers that can include contains decimals.

Example 

23.08

associated_roles (role)

Roles assigned to the user.

associated_roles (role)

status (string)read only

Active status of the user.

status (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

user_udf_fields (user_udf_fields)

User - Additional fields of the particular user.

user_udf_fields (user_udf_fields)

cost_per_hour (double)

User’s pay in cost per hour.

cost_per_hour (double)
These are numbers that can include contains decimals.

Example 

23.08

service_request_approver (boolean)

Indicates whether the user is allowed to approve service requests.

service_request_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

reporting_to (orguser)

Reporting user.

reporting_to (orguser)

jobtitle (string)

Job title of the user.

jobtitle (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)

Time at which the user is added to the organisation.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

created_time (datetime)read only

Time at which the user is added to the organisation.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

department (department)

Department to which the user belongs.

department (department)

login_name (string)

Username/Email to log in to the application.

login_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (domain)

Domain to which the user belongs.

domain (domain)

is_vipuser (boolean)

Indicates whether the user is a VIP user.

is_vipuser (boolean)
Boolean value which can have two possible values. The values are true and false.

sms_mail_id (string)

Sms mail Id of the user.

sms_mail_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

profile_pic (media)

URL of the user’s profile picture.

profile_pic (media)

password (password)

Password to log in to the application.

password (password)

is_technician (boolean)

Indicates whether the user is a technician.

is_technician (boolean)
Boolean value which can have two possible values. The values are true and false.

purchase_approver (boolean)

Indicates whether the user is allowed to approve purchase orders.

purchase_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

project_roles (project_role)

Project roles assigned to the user.

project_roles (project_role)

requester_allowed_to_view (long)

Permissions for the user to view requests.

requester_allowed_to_view (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

Add User

No Description

Mandatory Fields :- name

Url

<service domain|custom domain>/app/<portal>//api/v3/users

Attributes

id (long)
Unique user identity.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

first_name (string)
First name of the user.

first_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

middle_name (string)
Middle name of the user.

middle_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

last_name (string)
Last name of the user.

last_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

name (string)
Name of the user.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

employee_id (string)
Unique employee id assigned to the user.

employee_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

More Attributes Expand all

email_id (string)

Email address of the user.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

secondary_emailids (string)

Secondary email addresses of the user.

secondary_emailids (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

phone (string)

Phone number of the user.

phone (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile number of the user.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

purchase_approval_limit (double)

Amount up to which purchase order approval is permitted for the user.

purchase_approval_limit (double)
These are numbers that can include contains decimals.

Example 

23.08

associated_roles (role)

Roles assigned to the user.

associated_roles (role)

status (string)read only

Active status of the user.

status (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

user_udf_fields (user_udf_fields)

User - Additional fields of the particular user.

user_udf_fields (user_udf_fields)

cost_per_hour (double)

User’s pay in cost per hour.

cost_per_hour (double)
These are numbers that can include contains decimals.

Example 

23.08

service_request_approver (boolean)

Indicates whether the user is allowed to approve service requests.

service_request_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

reporting_to (orguser)

Reporting user.

reporting_to (orguser)

jobtitle (string)

Job title of the user.

jobtitle (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)

Time at which the user is added to the organisation.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

created_time (datetime)read only

Time at which the user is added to the organisation.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

department (department)

Department to which the user belongs.

department (department)

login_name (string)

Username/Email to log in to the application.

login_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (domain)

Domain to which the user belongs.

domain (domain)

is_vipuser (boolean)

Indicates whether the user is a VIP user.

is_vipuser (boolean)
Boolean value which can have two possible values. The values are true and false.

sms_mail_id (string)

Sms mail Id of the user.

sms_mail_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

profile_pic (media)

URL of the user’s profile picture.

profile_pic (media)

password (password)

Password to log in to the application.

password (password)

is_technician (boolean)

Indicates whether the user is a technician.

is_technician (boolean)
Boolean value which can have two possible values. The values are true and false.

purchase_approver (boolean)

Indicates whether the user is allowed to approve purchase orders.

purchase_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

project_roles (project_role)

Project roles assigned to the user.

project_roles (project_role)

requester_allowed_to_view (long)

Permissions for the user to view requests.

requester_allowed_to_view (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500


$ curl <service domain|custom domain>/app/<portal>//api/v3/users\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
    "user": {
        "first_name": "Peter",
        "middle_name": "Rabbit",
        "last_name": "Atom",
        "name": "Peter Rabbit Atom",
        "is_vipuser": "false",
        "employee_id": "4229",
        "department": {
            "id": "5"
        },
        "mobile": "02892902",
        "description": "Help Desk manager",
        "sms_mail_id": "user1@zylker.com",
        "jobtitle": "Java developer",
        "phone": "929992",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "rabbit@zylker.com",
            "atom@zylker.com"
        ],
        "cost_per_hour": "929",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "-1",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "requester_allowed_to_view": "0",
        "login_name": "peter",
        "password": "peter",
        "domain": {
            "id": "2"
        },
        "user_udf_fields": {
            "udf_long_3": "982999292",
            "udf_date_4": {
                "value": "1569519360000"
            },
            "udf_pick_2": "Market gaps",
            "udf_sline_1": "Manager"
        },
        "ci_default_fields": {
            "udf_pick_165": "Team member",
            "udf_pickref_1": {
                "id": 2
            },
            "udf_sline_164": "Testing line"
        },
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_sline_158": "929",
            "udf_pick_163": "7 th floor",
            "udf_pickref_161": {
                "id": "6"
            },
            "udf_pickref_159": {
                "id": "2"
            },
            "udf_sline_162": "928KSi82"
        }
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/users";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "user": {
        "first_name": "Peter",
        "middle_name": "Rabbit",
        "last_name": "Atom",
        "name": "Peter Rabbit Atom",
        "is_vipuser": "false",
        "employee_id": "4229",
        "department": {
            "id": "5"
        },
        "mobile": "02892902",
        "description": "Help Desk manager",
        "sms_mail_id": "user1@zylker.com",
        "jobtitle": "Java developer",
        "phone": "929992",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "rabbit@zylker.com",
            "atom@zylker.com"
        ],
        "cost_per_hour": "929",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "-1",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "requester_allowed_to_view": "0",
        "login_name": "peter",
        "password": "peter",
        "domain": {
            "id": "2"
        },
        "user_udf_fields": {
            "udf_long_3": "982999292",
            "udf_date_4": {
                "value": "1569519360000"
            },
            "udf_pick_2": "Market gaps",
            "udf_sline_1": "Manager"
        },
        "ci_default_fields": {
            "udf_pick_165": "Team member",
            "udf_pickref_1": {
                "id": 2
            },
            "udf_sline_164": "Testing line"
        },
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_sline_158": "929",
            "udf_pick_163": "7 th floor",
            "udf_pickref_161": {
                "id": "6"
            },
            "udf_pickref_159": {
                "id": "2"
            },
            "udf_sline_162": "928KSi82"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/users"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "user": {
        "first_name": "Peter",
        "middle_name": "Rabbit",
        "last_name": "Atom",
        "name": "Peter Rabbit Atom",
        "is_vipuser": "false",
        "employee_id": "4229",
        "department": {
            "id": "5"
        },
        "mobile": "02892902",
        "description": "Help Desk manager",
        "sms_mail_id": "user1@zylker.com",
        "jobtitle": "Java developer",
        "phone": "929992",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "rabbit@zylker.com",
            "atom@zylker.com"
        ],
        "cost_per_hour": "929",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "-1",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "requester_allowed_to_view": "0",
        "login_name": "peter",
        "password": "peter",
        "domain": {
            "id": "2"
        },
        "user_udf_fields": {
            "udf_long_3": "982999292",
            "udf_date_4": {
                "value": "1569519360000"
            },
            "udf_pick_2": "Market gaps",
            "udf_sline_1": "Manager"
        },
        "ci_default_fields": {
            "udf_pick_165": "Team member",
            "udf_pickref_1": {
                "id": 2
            },
            "udf_sline_164": "Testing line"
        },
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_sline_158": "929",
            "udf_pick_163": "7 th floor",
            "udf_pickref_161": {
                "id": "6"
            },
            "udf_pickref_159": {
                "id": "2"
            },
            "udf_sline_162": "928KSi82"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/users"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "user": {
        "first_name": "Peter",
        "middle_name": "Rabbit",
        "last_name": "Atom",
        "name": "Peter Rabbit Atom",
        "is_vipuser": "false",
        "employee_id": "4229",
        "department": {
            "id": "5"
        },
        "mobile": "02892902",
        "description": "Help Desk manager",
        "sms_mail_id": "user1@zylker.com",
        "jobtitle": "Java developer",
        "phone": "929992",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "rabbit@zylker.com",
            "atom@zylker.com"
        ],
        "cost_per_hour": "929",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "-1",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "requester_allowed_to_view": "0",
        "login_name": "peter",
        "password": "peter",
        "domain": {
            "id": "2"
        },
        "user_udf_fields": {
            "udf_long_3": "982999292",
            "udf_date_4": {
                "value": "1569519360000"
            },
            "udf_pick_2": "Market gaps",
            "udf_sline_1": "Manager"
        },
        "ci_default_fields": {
            "udf_pick_165": "Team member",
            "udf_pickref_1": {
                "id": 2
            },
            "udf_sline_164": "Testing line"
        },
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_sline_158": "929",
            "udf_pick_163": "7 th floor",
            "udf_pickref_161": {
                "id": "6"
            },
            "udf_pickref_159": {
                "id": "2"
            },
            "udf_sline_162": "928KSi82"
        }
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "user": {
        "first_name": "Peter",
        "middle_name": "Rabbit",
        "last_name": "Atom",
        "name": "Peter Rabbit Atom",
        "is_vipuser": false,
        "employee_id": "4229",
        "department": {
            "id": "5",
            "site": null,
            "name": "IT Services"
        },
        "mobile": "02892902",
        "description": "Help Desk manager",
        "sms_mail_id": "user1@zylker.com",
        "jobtitle": "Java developer",
        "phone": "929992",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "atom@zylker.com",
            "rabbit@zylker.com",
            "user1@zylker.com"
        ],
        "cost_per_hour": "929.00",
        "service_request_approver": true,
        "purchase_approver": true,
        "purchase_approval_limit": "-1.00",
        "project_roles": {
            "id": "3",
            "name": "Project Manager"
        },
        "reporting_to": {
            "id": "4",
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "department": null
        },
        "requester_allowed_to_view": null,
        "login_name": "peter",
        "domain": {
            "id": "2",
            "name": "ABC"
        },
        "user_udf_fields": {
            "udf_long_3": "982999292",
            "udf_date_4": {
                "value": "1569519360000",
                "display_value": "Sep 26, 2019 11:06 PM"
            },
            "udf_pick_2": "Market gaps",
            "udf_sline_1": "Manager"
        },
        "ci_default_fields": {
            "udf_pick_165": "Team member",
            "udf_pickref_1": {
                "id": 2,
                "name": "Medium"
            },
            "udf_sline_164": "Testing line"
        },
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_sline_158": "929",
            "udf_pick_163": "7 th floor",
            "udf_pickref_161": {
                "id": 6,
                "name": "Heather Graham"
            },
            "udf_pickref_159": {
                "id": 2,
                "site": null,
                "name": "Engineering"
            },
            "udf_sline_162": "928KSi82"
        },
        "attachments": [],
        "ci_people_fields": {},
        "org_roles": [],
        "type": "User",
        "org_user_status": "ACTIVE",
        "id": "10",
        "profile_pic": null,
        "created_time": {
            "display_value": "Sep 6, 2019 06:58 AM",
            "value": "1567733299627"
        },
        "is_technician": false,
        "ciid": "25",
        "associated_roles": [
            {
                "name": "SDGuest",
                "id": "29"
            }
        ],
        "status": "ACTIVE"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Edit User

No Description

Url

<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}

Attributes

id (long)
Unique user identity.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

first_name (string)
First name of the user.

first_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

middle_name (string)
Middle name of the user.

middle_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

last_name (string)
Last name of the user.

last_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

name (string)
Name of the user.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

employee_id (string)
Unique employee id assigned to the user.

employee_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

More Attributes Expand all

email_id (string)

Email address of the user.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

secondary_emailids (string)

Secondary email addresses of the user.

secondary_emailids (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

phone (string)

Phone number of the user.

phone (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile number of the user.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

purchase_approval_limit (double)

Amount up to which purchase order approval is permitted for the user.

purchase_approval_limit (double)
These are numbers that can include contains decimals.

Example 

23.08

associated_roles (role)

Roles assigned to the user.

associated_roles (role)

status (string)read only

Active status of the user.

status (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

user_udf_fields (user_udf_fields)

User - Additional fields of the particular user.

user_udf_fields (user_udf_fields)

cost_per_hour (double)

User’s pay in cost per hour.

cost_per_hour (double)
These are numbers that can include contains decimals.

Example 

23.08

service_request_approver (boolean)

Indicates whether the user is allowed to approve service requests.

service_request_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

reporting_to (orguser)

Reporting user.

reporting_to (orguser)

jobtitle (string)

Job title of the user.

jobtitle (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)

Time at which the user is added to the organisation.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

created_time (datetime)read only

Time at which the user is added to the organisation.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

department (department)

Department to which the user belongs.

department (department)

login_name (string)

Username/Email to log in to the application.

login_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (domain)

Domain to which the user belongs.

domain (domain)

is_vipuser (boolean)

Indicates whether the user is a VIP user.

is_vipuser (boolean)
Boolean value which can have two possible values. The values are true and false.

sms_mail_id (string)

Sms mail Id of the user.

sms_mail_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

profile_pic (media)

URL of the user’s profile picture.

profile_pic (media)

password (password)

Password to log in to the application.

password (password)

is_technician (boolean)

Indicates whether the user is a technician.

is_technician (boolean)
Boolean value which can have two possible values. The values are true and false.

purchase_approver (boolean)

Indicates whether the user is allowed to approve purchase orders.

purchase_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

project_roles (project_role)

Project roles assigned to the user.

project_roles (project_role)

requester_allowed_to_view (long)

Permissions for the user to view requests.

requester_allowed_to_view (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500


$ curl <service domain|custom domain>/app/<portal>//api/v3/users/{user_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
    "user": {
        "email_id": "guest@zylker.com",
        "purchase_approver": "true",
        "description": "End User of the software product",
        "is_vipuser": "false",
        "reporting_to": {
            "id": "4"
        },
        "cost_per_hour": "500.00",
        "ci_default_fields": {
            "udf_pickref_1": {
                "id": 1
            },
            "udf_pick_165": "Team member",
            "udf_sline_164": null
        },
        "department": {
            "id": "1"
        },
        "first_name": null,
        "service_request_approver": "true",
        "jobtitle": null,
        "mobile": "1234567890",
        "project_roles": {
            "id": "3"
        },
        "last_name": null,
        "sms_mail_id": null,
        "middle_name": null,
        "purchase_approval_limit": "1000.00",
        "secondary_emailids": [
            "asd1@zylker.com",
            "user1@zylker.com"
        ],
        "login_name": "guest",
        "requester_allowed_to_view": "0",
        "phone": "8888",
        "employee_id": "888",
        "domain": {
            "id": "1"
        },
        "name": "Guest",
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_pickref_161": {
                "id": 4
            },
            "udf_sline_158": "Software analyst",
            "udf_pickref_159": {
                "id": 2
            },
            "udf_pick_163": "5 th floor",
            "udf_sline_162": "12LE35"
        },
        "user_udf_fields": {
            "udf_pick_2": "support",
            "udf_long_3": "9823881",
            "udf_sline_1": "Active",
            "udf_date_4": {
                "value": "1569432180000"
            }
        }
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "user": {
        "email_id": "guest@zylker.com",
        "purchase_approver": "true",
        "description": "End User of the software product",
        "is_vipuser": "false",
        "reporting_to": {
            "id": "4"
        },
        "cost_per_hour": "500.00",
        "ci_default_fields": {
            "udf_pickref_1": {
                "id": 1
            },
            "udf_pick_165": "Team member",
            "udf_sline_164": null
        },
        "department": {
            "id": "1"
        },
        "first_name": null,
        "service_request_approver": "true",
        "jobtitle": null,
        "mobile": "1234567890",
        "project_roles": {
            "id": "3"
        },
        "last_name": null,
        "sms_mail_id": null,
        "middle_name": null,
        "purchase_approval_limit": "1000.00",
        "secondary_emailids": [
            "asd1@zylker.com",
            "user1@zylker.com"
        ],
        "login_name": "guest",
        "requester_allowed_to_view": "0",
        "phone": "8888",
        "employee_id": "888",
        "domain": {
            "id": "1"
        },
        "name": "Guest",
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_pickref_161": {
                "id": 4
            },
            "udf_sline_158": "Software analyst",
            "udf_pickref_159": {
                "id": 2
            },
            "udf_pick_163": "5 th floor",
            "udf_sline_162": "12LE35"
        },
        "user_udf_fields": {
            "udf_pick_2": "support",
            "udf_long_3": "9823881",
            "udf_sline_1": "Active",
            "udf_date_4": {
                "value": "1569432180000"
            }
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "user": {
        "email_id": "guest@zylker.com",
        "purchase_approver": "true",
        "description": "End User of the software product",
        "is_vipuser": "false",
        "reporting_to": {
            "id": "4"
        },
        "cost_per_hour": "500.00",
        "ci_default_fields": {
            "udf_pickref_1": {
                "id": 1
            },
            "udf_pick_165": "Team member",
            "udf_sline_164": null
        },
        "department": {
            "id": "1"
        },
        "first_name": null,
        "service_request_approver": "true",
        "jobtitle": null,
        "mobile": "1234567890",
        "project_roles": {
            "id": "3"
        },
        "last_name": null,
        "sms_mail_id": null,
        "middle_name": null,
        "purchase_approval_limit": "1000.00",
        "secondary_emailids": [
            "asd1@zylker.com",
            "user1@zylker.com"
        ],
        "login_name": "guest",
        "requester_allowed_to_view": "0",
        "phone": "8888",
        "employee_id": "888",
        "domain": {
            "id": "1"
        },
        "name": "Guest",
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_pickref_161": {
                "id": 4
            },
            "udf_sline_158": "Software analyst",
            "udf_pickref_159": {
                "id": 2
            },
            "udf_pick_163": "5 th floor",
            "udf_sline_162": "12LE35"
        },
        "user_udf_fields": {
            "udf_pick_2": "support",
            "udf_long_3": "9823881",
            "udf_sline_1": "Active",
            "udf_date_4": {
                "value": "1569432180000"
            }
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "user": {
        "email_id": "guest@zylker.com",
        "purchase_approver": "true",
        "description": "End User of the software product",
        "is_vipuser": "false",
        "reporting_to": {
            "id": "4"
        },
        "cost_per_hour": "500.00",
        "ci_default_fields": {
            "udf_pickref_1": {
                "id": 1
            },
            "udf_pick_165": "Team member",
            "udf_sline_164": null
        },
        "department": {
            "id": "1"
        },
        "first_name": null,
        "service_request_approver": "true",
        "jobtitle": null,
        "mobile": "1234567890",
        "project_roles": {
            "id": "3"
        },
        "last_name": null,
        "sms_mail_id": null,
        "middle_name": null,
        "purchase_approval_limit": "1000.00",
        "secondary_emailids": [
            "asd1@zylker.com",
            "user1@zylker.com"
        ],
        "login_name": "guest",
        "requester_allowed_to_view": "0",
        "phone": "8888",
        "employee_id": "888",
        "domain": {
            "id": "1"
        },
        "name": "Guest",
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_pickref_161": {
                "id": 4
            },
            "udf_sline_158": "Software analyst",
            "udf_pickref_159": {
                "id": 2
            },
            "udf_pick_163": "5 th floor",
            "udf_sline_162": "12LE35"
        },
        "user_udf_fields": {
            "udf_pick_2": "support",
            "udf_long_3": "9823881",
            "udf_sline_1": "Active",
            "udf_date_4": {
                "value": "1569432180000"
            }
        }
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "user": {
        "email_id": "guest@zylker.com",
        "purchase_approver": true,
        "description": "End User of the software product",
        "is_vipuser": false,
        "reporting_to": {
            "id": "4",
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "department": null
        },
        "cost_per_hour": "500.00",
        "ci_default_fields": {
            "udf_pickref_1": {
                "id": 1,
                "name": "High"
            },
            "udf_pick_165": "Team member",
            "udf_sline_164": null
        },
        "department": {
            "id": "1",
            "site": null,
            "name": "Administration"
        },
        "first_name": null,
        "service_request_approver": true,
        "jobtitle": null,
        "mobile": "1234567890",
        "project_roles": {
            "id": "3",
            "name": "Project Manager"
        },
        "last_name": null,
        "sms_mail_id": null,
        "middle_name": null,
        "purchase_approval_limit": "1000.00",
        "secondary_emailids": [
            "guest@zylker.com",
            "user1@zylker.com"
        ],
        "login_name": "guest",
        "requester_allowed_to_view": null,
        "phone": "8888",
        "employee_id": "888",
        "domain": {
            "id": "1",
            "name": "WORKGROUP"
        },
        "name": "Guest",
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_pickref_161": {
                "id": 4,
                "name": "administrator"
            },
            "udf_sline_158": "Software analyst",
            "udf_pickref_159": {
                "id": 2,
                "site": null,
                "name": "Engineering"
            },
            "udf_pick_163": "5 th floor",
            "udf_sline_162": "12LE35"
        },
        "user_udf_fields": {
            "udf_pick_2": "support",
            "udf_long_3": "9823881",
            "udf_sline_1": "Active",
            "udf_date_4": {
                "value": "1569432180000",
                "display_value": "Sep 25, 2019 10:53 PM"
            }
        },
        "attachments": [],
        "ci_people_fields": {},
        "org_roles": [],
        "type": "User",
        "org_user_status": "ACTIVE",
        "id": "3",
        "profile_pic": null,
        "created_time": {
            "display_value": "Sep 6, 2019 05:30 AM",
            "value": "1567728017353"
        },
        "is_technician": false,
        "ciid": "17",
        "associated_roles": [
            {
                "name": "SDGuest",
                "id": "29"
            }
        ],
        "status": "ACTIVE"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get User

No Description

Url

<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}

Attributes

id (long)
Unique user identity.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

first_name (string)
First name of the user.

first_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

middle_name (string)
Middle name of the user.

middle_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

last_name (string)
Last name of the user.

last_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

name (string)
Name of the user.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

employee_id (string)
Unique employee id assigned to the user.

employee_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

More Attributes Expand all

email_id (string)

Email address of the user.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

secondary_emailids (string)

Secondary email addresses of the user.

secondary_emailids (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

phone (string)

Phone number of the user.

phone (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile number of the user.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

purchase_approval_limit (double)

Amount up to which purchase order approval is permitted for the user.

purchase_approval_limit (double)
These are numbers that can include contains decimals.

Example 

23.08

associated_roles (role)

Roles assigned to the user.

associated_roles (role)

status (string)read only

Active status of the user.

status (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

user_udf_fields (user_udf_fields)

User - Additional fields of the particular user.

user_udf_fields (user_udf_fields)

cost_per_hour (double)

User’s pay in cost per hour.

cost_per_hour (double)
These are numbers that can include contains decimals.

Example 

23.08

service_request_approver (boolean)

Indicates whether the user is allowed to approve service requests.

service_request_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

reporting_to (orguser)

Reporting user.

reporting_to (orguser)

jobtitle (string)

Job title of the user.

jobtitle (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)

Time at which the user is added to the organisation.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

created_time (datetime)read only

Time at which the user is added to the organisation.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

department (department)

Department to which the user belongs.

department (department)

login_name (string)

Username/Email to log in to the application.

login_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (domain)

Domain to which the user belongs.

domain (domain)

is_vipuser (boolean)

Indicates whether the user is a VIP user.

is_vipuser (boolean)
Boolean value which can have two possible values. The values are true and false.

sms_mail_id (string)

Sms mail Id of the user.

sms_mail_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

profile_pic (media)

URL of the user’s profile picture.

profile_pic (media)

password (password)

Password to log in to the application.

password (password)

is_technician (boolean)

Indicates whether the user is a technician.

is_technician (boolean)
Boolean value which can have two possible values. The values are true and false.

purchase_approver (boolean)

Indicates whether the user is allowed to approve purchase orders.

purchase_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

project_roles (project_role)

Project roles assigned to the user.

project_roles (project_role)

requester_allowed_to_view (long)

Permissions for the user to view requests.

requester_allowed_to_view (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500


$ curl -G <service domain|custom domain>/app/<portal>//api/v3/users/{user_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "user": {
        "email_id": "guest@zylker.com",
        "purchase_approver": true,
        "attachments": [],
        "ci_people_fields": {},
        "org_roles": [],
        "description": "End User of the software product",
        "is_vipuser": false,
        "reporting_to": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "type": "User",
        "cost_per_hour": "500.00",
        "ci_default_fields": {
            "udf_pickref_1": {
                "name": "High",
                "id": 1
            },
            "udf_pick_165": "Team member",
            "udf_sline_164": null
        },
        "org_user_status": "ACTIVE",
        "id": "3",
        "department": {
            "site": null,
            "name": "Administration",
            "id": "1"
        },
        "first_name": null,
        "profile_pic": null,
        "service_request_approver": true,
        "created_time": {
            "display_value": "Sep 6, 2019 05:30 AM",
            "value": "1567728017353"
        },
        "is_technician": false,
        "jobtitle": null,
        "mobile": "1234567890",
        "project_roles": {
            "name": "Project Manager",
            "id": "3"
        },
        "last_name": null,
        "sms_mail_id": null,
        "middle_name": null,
        "ciid": "17",
        "purchase_approval_limit": "1000.00",
        "secondary_emailids": [
            "asd1@zylker.com",
            "user1@zylker.com"
        ],
        "login_name": "guest",
        "requester_allowed_to_view": null,
        "phone": "8888",
        "employee_id": "888",
        "domain": {
            "name": "WORKGROUP",
            "id": "1"
        },
        "name": "Guest",
        "ci_user_fields": {
            "udf_pickref_160": null,
            "udf_pickref_161": {
                "name": "administrator",
                "id": 4
            },
            "udf_sline_158": "Software analyst",
            "udf_pickref_159": {
                "site": null,
                "name": "Engineering",
                "id": 2
            },
            "udf_pick_163": "5 th floor",
            "udf_sline_162": "12LE35"
        },
        "user_udf_fields": {
            "udf_pick_2": "support",
            "udf_long_3": "9823881",
            "udf_sline_1": "Active",
            "udf_date_4": {
                "display_value": "Sep 25, 2019 10:53 PM",
                "value": "1569432180000"
            }
        },
        "associated_roles": [
            {
                "name": "SDGuest",
                "id": "29"
            }
        ],
        "status": "ACTIVE"
    }
}

Get List User

No Description

Url

<service domain|custom domain>/app/<portal>//api/v3/users

Attributes

id (long)
Unique user identity.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

first_name (string)
First name of the user.

first_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

middle_name (string)
Middle name of the user.

middle_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

last_name (string)
Last name of the user.

last_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

name (string)
Name of the user.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

employee_id (string)
Unique employee id assigned to the user.

employee_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

More Attributes Expand all

email_id (string)

Email address of the user.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

secondary_emailids (string)

Secondary email addresses of the user.

secondary_emailids (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

phone (string)

Phone number of the user.

phone (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile number of the user.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

purchase_approval_limit (double)

Amount up to which purchase order approval is permitted for the user.

purchase_approval_limit (double)
These are numbers that can include contains decimals.

Example 

23.08

associated_roles (role)

Roles assigned to the user.

associated_roles (role)

status (string)read only

Active status of the user.

status (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

user_udf_fields (user_udf_fields)

User - Additional fields of the particular user.

user_udf_fields (user_udf_fields)

cost_per_hour (double)

User’s pay in cost per hour.

cost_per_hour (double)
These are numbers that can include contains decimals.

Example 

23.08

service_request_approver (boolean)

Indicates whether the user is allowed to approve service requests.

service_request_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

reporting_to (orguser)

Reporting user.

reporting_to (orguser)

jobtitle (string)

Job title of the user.

jobtitle (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)

Time at which the user is added to the organisation.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

created_time (datetime)read only

Time at which the user is added to the organisation.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

department (department)

Department to which the user belongs.

department (department)

login_name (string)

Username/Email to log in to the application.

login_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (domain)

Domain to which the user belongs.

domain (domain)

is_vipuser (boolean)

Indicates whether the user is a VIP user.

is_vipuser (boolean)
Boolean value which can have two possible values. The values are true and false.

sms_mail_id (string)

Sms mail Id of the user.

sms_mail_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

guest@zylker.com

profile_pic (media)

URL of the user’s profile picture.

profile_pic (media)

password (password)

Password to log in to the application.

password (password)

is_technician (boolean)

Indicates whether the user is a technician.

is_technician (boolean)
Boolean value which can have two possible values. The values are true and false.

purchase_approver (boolean)

Indicates whether the user is allowed to approve purchase orders.

purchase_approver (boolean)
Boolean value which can have two possible values. The values are true and false.

project_roles (project_role)

Project roles assigned to the user.

project_roles (project_role)

requester_allowed_to_view (long)

Permissions for the user to view requests.

requester_allowed_to_view (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500


$ curl -G <service domain|custom domain>/app/<portal>//api/v3/users\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{
    "list_info": {
        "sort_field": "name",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": "25",
        "get_total_count": true,
        "search_fields": {
            "email_id": "guest@zylker.com"
        }
    },
    "fields_required": [
        "name",
        "is_technician",
        "citype",
        "login_name",
        "email_id",
        "department",
        "phone",
        "mobile",
        "jobtitle",
        "project_roles",
        "employee_id",
        "first_name",
        "middle_name",
        "last_name",
        "is_vipuser",
        "ciid"
    ]
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/users";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "list_info": {
        "sort_field": "name",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": "25",
        "get_total_count": true,
        "search_fields": {
            "email_id": "guest@zylker.com"
        }
    },
    "fields_required": [
        "name",
        "is_technician",
        "citype",
        "login_name",
        "email_id",
        "department",
        "phone",
        "mobile",
        "jobtitle",
        "project_roles",
        "employee_id",
        "first_name",
        "middle_name",
        "last_name",
        "is_vipuser",
        "ciid"
    ]
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/users"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{
    "list_info": {
        "sort_field": "name",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": "25",
        "get_total_count": true,
        "search_fields": {
            "email_id": "guest@zylker.com"
        }
    },
    "fields_required": [
        "name",
        "is_technician",
        "citype",
        "login_name",
        "email_id",
        "department",
        "phone",
        "mobile",
        "jobtitle",
        "project_roles",
        "employee_id",
        "first_name",
        "middle_name",
        "last_name",
        "is_vipuser",
        "ciid"
    ]
}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/users"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "list_info": {
        "sort_field": "name",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": "25",
        "get_total_count": true,
        "search_fields": {
            "email_id": "guest@zylker.com"
        }
    },
    "fields_required": [
        "name",
        "is_technician",
        "citype",
        "login_name",
        "email_id",
        "department",
        "phone",
        "mobile",
        "jobtitle",
        "project_roles",
        "employee_id",
        "first_name",
        "middle_name",
        "last_name",
        "is_vipuser",
        "ciid"
    ]
}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "list_info": {
        "sort_field": "name",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": 1,
        "get_total_count": "true",
        "search_fields": {
            "email_id": "guest@zylker.com"
        },
        "has_more_rows": false,
        "total_count": 1
    },
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "users": [
        {
            "email_id": "guest@zylker.com",
            "is_technician": false,
            "jobtitle": null,
            "ci_people_fields": {},
            "mobile": "1234567890",
            "project_roles": {
                "name": "Project Manager",
                "id": "3"
            },
            "last_name": null,
            "is_vipuser": false,
            "middle_name": null,
            "type": "User",
            "citype": {
                "name": "User",
                "id": 3
            },
            "ciid": "17",
            "ci_default_fields": {
                "udf_pickref_1": {
                    "name": "High",
                    "id": 1
                },
                "udf_pick_165": "Team member",
                "udf_sline_164": null
            },
            "login_name": "guest",
            "phone": "8888",
            "employee_id": "888",
            "name": "Guest",
            "ci_user_fields": {
                "udf_pickref_160": null,
                "udf_pickref_161": {
                    "name": "administrator",
                    "id": 4
                },
                "udf_sline_158": "Software analyst",
                "udf_pickref_159": {
                    "site": null,
                    "name": "Engineering",
                    "id": 2
                },
                "udf_pick_163": "5 th floor",
                "udf_sline_162": "12LE35"
            },
            "id": "3",
            "department": {
                "site": null,
                "name": "Administration",
                "id": "1"
            },
            "first_name": null
        }
    ]
}

Delete User

No Description

Url

<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}


$ curl <service domain|custom domain>/app/<portal>//api/v3/users/{user_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Change As Technician

No Description

Url

<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}/change_as_technician


$ curl <service domain|custom domain>/app/<portal>//api/v3/users/{user_id}/change_as_technician\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
    "technician": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "name": "Guest",
        "is_vipuser": "false",
        "employee_id": "888",
        "department": {
            "id": "2"
        },
        "mobile": "1234567890",
        "description": "End User of the software product",
        "sms_mail_id": null,
        "jobtitle": null,
        "phone": "8888",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "guest@zylker.com"
        ],
        "cost_per_hour": "500.00",
        "allowed_to_view_cost": "false",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "1000.00",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "login_name": "guest",
        "associated_roles": [
            {
                "id": "108"
            }
        ],
        "user_udf_fields": {
            "udf_long_3": "9823881",
            "udf_date_4": {
                "value": "1569432180000"
            },
            "udf_pick_2": "support",
            "udf_sline_1": "Active"
        },
        "technician_udf_fields": {
            "udf_pick_6": null,
            "udf_long_7": null,
            "udf_sline_5": null
        },
        "associated_sites": [
            {
                "id": "-1"
            },
            {
                "id": "601"
            }
        ],
        "support_group": [
            {
                "id": "7"
            },
            {
                "id": "8"
            }
        ]
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}/change_as_technician";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "technician": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "name": "Guest",
        "is_vipuser": "false",
        "employee_id": "888",
        "department": {
            "id": "2"
        },
        "mobile": "1234567890",
        "description": "End User of the software product",
        "sms_mail_id": null,
        "jobtitle": null,
        "phone": "8888",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "guest@zylker.com"
        ],
        "cost_per_hour": "500.00",
        "allowed_to_view_cost": "false",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "1000.00",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "login_name": "guest",
        "associated_roles": [
            {
                "id": "108"
            }
        ],
        "user_udf_fields": {
            "udf_long_3": "9823881",
            "udf_date_4": {
                "value": "1569432180000"
            },
            "udf_pick_2": "support",
            "udf_sline_1": "Active"
        },
        "technician_udf_fields": {
            "udf_pick_6": null,
            "udf_long_7": null,
            "udf_sline_5": null
        },
        "associated_sites": [
            {
                "id": "-1"
            },
            {
                "id": "601"
            }
        ],
        "support_group": [
            {
                "id": "7"
            },
            {
                "id": "8"
            }
        ]
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}/change_as_technician"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "technician": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "name": "Guest",
        "is_vipuser": "false",
        "employee_id": "888",
        "department": {
            "id": "2"
        },
        "mobile": "1234567890",
        "description": "End User of the software product",
        "sms_mail_id": null,
        "jobtitle": null,
        "phone": "8888",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "guest@zylker.com"
        ],
        "cost_per_hour": "500.00",
        "allowed_to_view_cost": "false",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "1000.00",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "login_name": "guest",
        "associated_roles": [
            {
                "id": "108"
            }
        ],
        "user_udf_fields": {
            "udf_long_3": "9823881",
            "udf_date_4": {
                "value": "1569432180000"
            },
            "udf_pick_2": "support",
            "udf_sline_1": "Active"
        },
        "technician_udf_fields": {
            "udf_pick_6": null,
            "udf_long_7": null,
            "udf_sline_5": null
        },
        "associated_sites": [
            {
                "id": "-1"
            },
            {
                "id": "601"
            }
        ],
        "support_group": [
            {
                "id": "7"
            },
            {
                "id": "8"
            }
        ]
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/users/{user_id}/change_as_technician"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "technician": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "name": "Guest",
        "is_vipuser": "false",
        "employee_id": "888",
        "department": {
            "id": "2"
        },
        "mobile": "1234567890",
        "description": "End User of the software product",
        "sms_mail_id": null,
        "jobtitle": null,
        "phone": "8888",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "guest@zylker.com"
        ],
        "cost_per_hour": "500.00",
        "allowed_to_view_cost": "false",
        "service_request_approver": "true",
        "purchase_approver": "true",
        "purchase_approval_limit": "1000.00",
        "project_roles": {
            "id": "3"
        },
        "reporting_to": {
            "id": "4"
        },
        "login_name": "guest",
        "associated_roles": [
            {
                "id": "108"
            }
        ],
        "user_udf_fields": {
            "udf_long_3": "9823881",
            "udf_date_4": {
                "value": "1569432180000"
            },
            "udf_pick_2": "support",
            "udf_sline_1": "Active"
        },
        "technician_udf_fields": {
            "udf_pick_6": null,
            "udf_long_7": null,
            "udf_sline_5": null
        },
        "associated_sites": [
            {
                "id": "-1"
            },
            {
                "id": "601"
            }
        ],
        "support_group": [
            {
                "id": "7"
            },
            {
                "id": "8"
            }
        ]
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "technician": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "name": "Guest",
        "is_vipuser": false,
        "employee_id": "888",
        "department": {
            "id": "2",
            "site": null,
            "name": "Engineering"
        },
        "mobile": "1234567890",
        "description": "End User of the software product",
        "sms_mail_id": null,
        "jobtitle": null,
        "phone": "8888",
        "email_id": "guest@zylker.com",
        "secondary_emailids": [
            "user1@zylker.com",
            "asd2@zylker.com"
        ],
        "cost_per_hour": "500.00",
        "allowed_to_view_cost": false,
        "service_request_approver": true,
        "purchase_approver": true,
        "purchase_approval_limit": "1000.00",
        "project_roles": {
            "id": "3",
            "name": "Project Manager"
        },
        "reporting_to": {
            "id": "4",
            "email_id": "user1@zylker.com",
            "name": "administrator",
            "is_vipuser": false,
            "department": {
                "site": null,
                "name": "Finance",
                "id": 4
            }
        },
        "login_name": "guest",
        "associated_roles": [
            {
                "id": "108",
                "name": "HelpdeskConfig"
            },
            {
                "name": "Resources not in any site",
                "id": "60"
            },
            {
                "name": "ViewRequestsNotInAnySite",
                "id": "58"
            },
            {
                "name": "ViewRequester",
                "id": "94"
            }
        ],
        "user_udf_fields": {
            "udf_long_3": "9823881",
            "udf_date_4": {
                "value": "1569432180000",
                "display_value": "Sep 25, 2019 10:53 PM"
            },
            "udf_pick_2": "support",
            "udf_sline_1": "Active"
        },
        "technician_udf_fields": {
            "udf_pick_6": null,
            "udf_long_7": null,
            "udf_sline_5": null
        },
        "associated_sites": [
            {
                "id": "601",
                "name": "India"
            },
            {
                "id": "-1",
                "name": "Not associated to any site"
            }
        ],
        "support_group": [
            {
                "id": "7",
                "site": {
                    "name": "India",
                    "id": "601"
                },
                "name": "Hardware Problems"
            },
            {
                "id": "8",
                "site": {
                    "name": "India",
                    "id": "601"
                },
                "name": "Network"
            }
        ],
        "portaluser_id": "1",
        "org_roles": [
            {
                "name": "Reporting To",
                "id": 2
            }
        ],
        "type": "Technician",
        "org_user_status": "ACTIVE",
        "id": "3",
        "profile_pic": null,
        "created_time": {
            "display_value": "Sep 6, 2019 05:30 AM",
            "value": "1567728017353"
        },
        "aaaaccpass_id": "1",
        "sip_user": null,
        "domain": {
            "name": "WORKGROUP",
            "id": "1"
        },
        "status": "ACTIVE",
        "extension": null,
        "attachments": [],
        "aaauser_id": "3",
        "sduser_id": "3",
        "account_id": "1",
        "is_in_ad": null,
        "enable_telephony": false
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

View more