Edit Integrated User

Overview

Use this API to modify an existing integrated user. The logged in user can only modify one user at a time.

For this API to execute successfully:

A user with the ID specified in the request body must exist.
The user with the ID specified in the request body must be a department user.
At least one of the optional attributes must be provided.

NOTE:

To remove value of any element of type "String", "integer" or "dateTime", set the value to an empty string (instead of setting the value to null).
An integrated user gets its firstName, lastName, groups and password from Cisco Unified Contact Center Enterprise. Hence values for these attributes, if specified in the request body, are ignored.

Permissions

Actor	Permission
User	All of the following are required: If logged in user is a department user: User must have 'Edit' permission on the user being modified. If logged in user is a global user, one of the following is required: User must have 'Administer' permission on the department of the user being modified. User must have 'Manage partition resources' privilege.
Client Application	No additional permission is required.

SecurityoAuthUser or oAuthClient

Request

header Parameters

Accept required	string Default: application/json Content type accepted by client. Enum: "application/json" "application/xml"
Accept-Language required	string Default: en-US Language locale accepted by client (used for locale specific fields in resource representation and in error responses). Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"

Request Body schema: application/json

	object (title) Title of the user.
firstName	string (firstName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] First name of the user.
middleName	string (middleName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Middle name of the user.
lastName	string (lastName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Last name of the user.
screenName	string (screenName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Screen name of the user.
suffix	string (suffix) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Suffix of the user.
	object (createdBy) Details of the user who created this user.
lastModified required	string <date-time> (lastModified) Last modified date of the user.
loginId	string (loginId) <= 255 characters Login ID of the user.
password	string (password) Password for the user. This must adhere to the password complexity settings as configured in the application.
	object (authenticationType) Authentication type for the user.
	object (status) Status of the user.
	object (manager) Manager of the user.
emailAddress	string (emailAddress) <= 255 characters ^[a-zA-Z0-9-_]+@[a-zA-Z0-9-_]+\.[a-zA-Z0-9]+$... Primary email address of the user.
mobileNumber	string (mobileNumber) [ 5 .. 20 ] characters Mobile number of the user.
	object (directReports) Direct reports to the user.
	object (departments) Departments of the user.
	object (groups) Group details of the user.
	object (languages) Content languages of the user.
externalId	string (externalId) <= 255 characters External ID for the user.
	object (peripheral) Peripheral which user belongs to (Applicable only for integrated users)
	object (CustomAttributes) Custom attributes for the user.
id required	string (id) Id of the user.

Responses

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

406

Not Acceptable

409

Conflict

500

Internal server error

patch/integrated/user

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

Editing all attributes of an integrated user. Peripheral Id is provided in the request body.
PATCH /core/usermgr/v3/integrated/user

{"id": "1023",
"lastModified": "2021-10-29T11:06:24.000Z",
"firstName": "Anthony",
"lastName": "Shephard",
"screenName": "anthony",
"loginId": "ashephard",
"password": "password@123",
"title": {"value": "Mr."
},
"middleName": "R.",
"suffix": "jr.",
"status": {"value": "enabled"
},
"emailAddress": "cwilkins@company.com",
"manager": {"user": {"id": 1004
}
},
"mobileNumber": "123-456-7890",
"groups": {"link": [{"rel": "group",
"href": "/core/usermgr/v3/group/1011"
}
]
},
"languages": {"language": [{"code": "en-us",
"default": true
}
]
},
"directReports": {"link": [{"rel": "user",
"href": "/core/usermgr/v3/users/1005"
}
]
},
"peripheral": {"id": "5000"
},
"customAttributes": {"customAttribute": [{"attribName": "skills",
"attribValues": {"attribValue": [{"value": "phone"
}
]
}
}
]
}
}

Response samples

application/json

{"code": "400-101",
"developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}