Update User

Restriction: This API endpoint is not supported in the Free Trial cloud.

Use to update the information of an existing user in the system.

The following rules apply:

  • Parameters specified will overwrite existing property values
  • Parameters not specified will not change existing property values

To clear an existing property value, specify the parameter without a value.

Restriction: To be able to run this API, you need to be logged in as the user you want to update or be an Admin user or part of Perfecto Support.

URL

Copy 
http://<your-cloud>.app.perfectomobile.com/api/v1/users

Method

PATCH

Header parameters

Name

Description
Perfecto-Authorization

Security Token

Data parameters (body)

Parameter Type Default Description
username* string

The name of the user being created. This parameter is mandatory if the lab is not configured to use the email address as the user.
password string

The password for the user.
firstName string

The new user's first name.
lastName string

The new user's last name.
email string

The new user's email address.
enabled boolean

A flag that indicates if the user is enabled in the system.
isIdpUser boolean

A flag that indicates if the user is authenticated through a third-party identity provider (IdP).
tempPassword boolean

A flag that indicates if a temporary password is set for the user to log into the system for the first time.

idpLink string

The link to the third-party identity provider, if used.
idpUsername string

The username in the IdP system, if used.

* Mandatory parameter

Success response

Code: 200

Error response

Status and a generic error message

Example

Copy
JSON request
{
    "username":"username1",
    "lastName":"last_name"
}