PATCH/depts/{DeptId}/users/{UserId}

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Updates specified fields of a user profile in QAComplete.

Use this operation to update specific fields of an existing user profile in QAComplete.

The /depts/{DeptId}/users/{UserId} (PATCH) operation can be performed only on the user's primary department.

You cannot change a password for the existing user with this method. To set a password, a modified user should click Forgot Password on a QAComplete logon screen.

To update the whole user profile, use the /depts/{DeptId}/users/{UserId} (PUT) operation.

To add a new user, use the /depts/{DeptId}/users (POST) operation.

Authentication

Basic authentication using a user’s login and password. See Authentication for details.

Security Rights

The authenticating user must have administrator privileges.

Request Format

To update the user profile, send a PATCH request to the following URL:

http://{server}/rest-api/service/api/v1/depts/{DeptId}/users/{UserId}
URL parameters

DeptId  :  integer, required

The ID of the needed department.

UserId  :  integer, required

The ID of the user profile, which fields you want to update.

Body parameters

In the request body, pass the RequestUserPatch JSON object that specifies the user profile's fields to update:

{
  "FirstName": "string",
  "LastName": "string",
  "MiddleName": "string",
  "Email": "string",
  "IsSecurityAdmin": boolean,
  "Phone": "string",
  "IsAdAccount": boolean,
  "AdSearchValue": "string",
}

The property values you do not specify remain unchanged.

FirstName  :  string, required

The first name of the user to create.

LastName  :  string, required

The last name of the user to create.

MiddleName  :  string

The middle name of the user to create.

Email  :  string, required

An email of the user to create.

IsSecurityAdmin  :  boolean

True if the newly created user will be a security administrator, False otherwise.

Phone  :  string

A phone number of the user to create.

IsAdAccount  :  boolean

True if the newly created user will use an Active Directory account, False otherwise.

AdSearchValue  :  string

An Active Directory search value for the newly created user.

A sample request:

PATCH http://yourserver.com/rest-api/service/api/v1/depts/8162/users/24793 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 50

{
  "LastName": "Smith",
  "FirstName": "Oliver"
}

A sample request made by using cURL:

curl -u john@example.com:p@ssword -d @user.txt -H "Content-Type: application/json" -H "Accept: application/json" http://yourserver.com/service/api/v1/depts/8162/users/24793

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with the updated user profile.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 507


{
"id": 24793,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com",
"is_logged_on": false,
"is_security_admin": false,
"is_active": true,
"nbr_times_logon": 0,
"date_of_anniv": "1900-01-01T00:00:00.0000000",
"is_selected": false,
"update_user_id": 0,
"date_created": "2016-01-01T00:00:00.0000000",
"date_updated": "2016-01-01T00:00:00.0000000",
"discount": 0,
"import_id": 0,
"primary_dept_id": 8162,
"logon_attempts": 0,
"is_a_d_account": false
}

Error responses

If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.

See Also

Users REST API Reference

Highlight search results