Patch Users
This API call enables partial updates to a user without providing the entire user definition.
Note:
- The following fields are not updatable:
userName,password,userAccess.AccessAutomation,userAccess.AccessCertification,userAccess.AccessComplete,userAccess.AccessOperationalMatching. - A limit of 1000 user records are allowed per request to allow processing within request timeout value.
### Deactivation:
A user or multiple users can be deactivated if they do not have any assigned tasks, permissions, committees, etc. assigned to the user by setting
active=false. These assignments will not be removed or unassigned through this process. Setting thedryrun=trueparameter will send the request without committing the values. This enables the caller to see the response of the API without finalizing the values. In the case of deactivation, the API will return a list of tasks/permissions/groups that prevent a user from being deactivated.
Possible error messages
- General + System Admins cannot be deactivated
- JE/CERT + The user is assigned as a Reconciler/Reviewer/Approver account + The user is assigned as member of a Reconciler user group + The user is assigned as member of JEPreparer group or JESecurity group + The user is assigned with an Approver role + The user is assigned as a manager role + The user is assigned as Preparer/Reviewer/Approver on a task profile + The user is assigned to a JE Dynamic Approver Routing Table + The user is in a Pick List
- Close + The user has active Close tasks + The user is currently assigned to a role on Close Task Details + The user is an owner permission/viewer permission of an entity or task + The user is a Close Admin + The user is part of a close Group
Query parameters
-
dryrun
string Returns users with username, first name or last name that starts with the searchText value.
PATCH
/users
curl \
--request PATCH 'https://localhost:8080/users' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '[{"userName":"testuser1","phoneNumber":"312-555-5555"},{"name":{"displayName":"Test A. User2"},"userName":"testuser2"}]'
Request example
[
{
"userName": "testuser1",
"phoneNumber": "312-555-5555"
},
{
"name": {
"displayName": "Test A. User2"
},
"userName": "testuser2"
}
]
Response examples (200)
{
"sucessCount": 1,
"failureCount": 1,
"failureResults": [],
"successResults": [
{
"id": "f1666d0e-b1ff-4367-b678-ca711623715c",
"action": "Updated",
"username": "testuser1"
},
{
"id": "b8c7fd11-10b5-454d-93a4-c854fcdaae81",
"action": "Updated",
"username": "testuser2"
}
],
"totalProcessed": 2
}
Response examples (400)
{
"sucessCount": 0,
"failureCount": 2,
"failureResults": [
{
"messages": [
"Invalid value for DepartmentId. Allowable values: ENG, SALES."
],
"username": "testuser1"
},
{
"messages": [
"Invalid value for LocationId. Allowable values: Americas, APAC, CON, Corporate, EMEA, Europe."
],
"username": "testuser2"
}
],
"successResults": [],
"totalProcessed": 2
}
Response examples (401)
{
"code": "900901",
"message": "Invalid Credentials",
"description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}