Update Users

Updates user attributes in an identity domain using either a CSV file upload (v1) or request payload (v2). These APIs can modify user properties such as first name, last name, and email for users identified by their user login.

Because user accounts are common to all service environments that share the identity domain, updates made to a user account are reflected across all environments associated with that identity domain.

Both APIs provide details about successful and failed user updates, including failure reasons and counts of passed and failed records.

The v1 API requires an ANSI or UTF-8 encoded CSV file containing user information and updated attribute values. Fields containing space characters must be enclosed in double quotation marks. Before running the API, the file must be uploaded to the environment using the Upload REST API, and the file should be deleted after the API executes. The CSV file should not include the account of the user executing the command. This API updates all properties of the user identified by the User Login field. The v1 API should be run only by Service Administrators who are also assigned to the Identity Domain Administrator role in the identity domain where users are to be updated. The v1 API is asynchronous and returns a Job ID that can be used to monitor the status of the operation.

In v1, a response status of -1 indicates that updating users is still in progress. Any non-zero status value indicates failure of updating users.

The v2 API accepts updated user attributes directly in the request payload. If a user definition in the payload matches an existing user account in the identity domain, no changes are made and the API returns an error response. This API should be run only by an Identity Domain Administrator in the identity domain where users are to be updated. In addition, the user running the API must also be assigned an application role in the target environment. This topic describes the simplified v2 version of the REST API. This version contains all parameters in the payload and does not require URL encoding while calling the REST APIs, which makes the v2 API easier to use. The v2 API is synchronous and returns the outcome of the operation directly in the response.

Required Roles

Identity Domain Administrator and any application role (Service Administrator, Power User, User, or Viewer)