Add Users to Groups

Adds batches of users to existing groups in Access Control using either a CSV file upload (v1) or request payload (v2).. Use the Upload REST API to upload the file. The file should be deleted after the API executes.

Note:

A user is added to the group only if both these conditions are met:

• User login IDs included in the file exist in the identity domain that services the environment
• The user is assigned to a application role in the identity domain

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

The v1 API requires an ANSI or UTF-8 encoded CSV file containing user login IDs or email addresses. 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. This API should be run only by a Service Administrator in the identity domain where users are to be added to the group. The v1 API is asynchronous and returns a Job ID that can be used to monitor the status of the operation.

The v2 API accepts all parameters directly in the request payload. 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.

In v1, a response status of -1 indicates that adding users to the group is still in progress. Any non-zero status value indicates failure of adding users to groups.

Required Roles

Service Administrator or any application role and the Access Control - Manage granular role