Manage Global Group Users with the Cloud Administration Global Groups API
This topic describes how to:
Note: To access these endpoints, an administrator needs the appropriate OAuth scope permissions. For more information, see OAuth 2.0-Based Permissions for the Cloud Administration APIs.
Add Users to a Global Group
The following information describes how to add users to a global group with the specified id.
Prerequisite: An administrator needs the rsa.group.users.manage OAuth permission to use this endpoint.
Request Requirements
Use the following information to add users to a global group with the specified id.
| Method | Request URL | Response Content Type | Response Body |
|---|---|---|---|
| PATCH | /AdminInterface/restapi/v1/localGroups/{id} | application/json | Object containing only id about the updated group. |
Request Body Parameters
The following table describes the request body parameters.
| Request Parameter | Description | Required | Data Type |
|---|---|---|---|
| userIds | List of user ids to add to the global group | Yes | List |
Example Request Body
The following is an example request body.
{
"userIds": ["0064ec40-498f-9273-58de-4119ac5024b9","01808d52-bea1-0408-e3b5-ba3f12bce78c","027bbdcc-713b-7670-6904-87f746f3a08c","04280576-fb25-09ee-0e3c-631a055bcdb2"]
}Resource Identifier
The following table shows the resource identifier for the global group required to add users to the specified group in the request URL.
| Resource Identifier | Required | Description | Type |
|---|---|---|---|
| <id> | Yes | ID of the global group to which users are added. | UUID |
Response Body Parameters
The following table describes the response body parameters.
| Parameter | Description | Data Type |
|---|---|---|
| id | Unique identifier that represents the global group. | UUID |
Example Response Body
The following is an example response body.
{
"id": "f6b0b45e-a0d6-2864-7ee5-71a9806977cc"
}
Response Codes
The following table lists the response codes and their descriptions for this API.
| HTTP Status Code | Description |
|---|---|
| 200 | Global group users added successfully. |
| 400 | Operation not performed because of client syntax errors. |
| 403 | Not authorized to perform the request. |
| 429 | Too many requests. |
| 500 | Internal error occurred when processing the request. |
Remove Users from a Global Group
The following information describes how to remove users from a global group with a specified id.
Prerequisite: An administrator needs the rsa.group.users.manage OAuth permission to use this endpoint.
Request Requirements
Use the following information to remove users from a global group with a specified id.
| Method | Request URL | Response Content Type | Response Body |
|---|---|---|---|
| DELETE | /AdminInterface/restapi/v1/localGroups/users/{id} | application/json | Object containing only id about the updated group. |
Request Body Parameters
The following table describes the request body parameters.
| Request Parameter | Description | Required | Data Type |
|---|---|---|---|
| userIds | List of user ids to remove from the global group. | Yes | List |
Example Request Body
The following is an example request body.
{
"userIds": ["0064ec40-498f-9273-58de-4119ac5024b9","01808d52-bea1-0408-e3b5-ba3f12bce78c","027bbdcc-713b-7670-6904-87f746f3a08c","04280576-fb25-09ee-0e3c-631a055bcdb2"]
}Resource Identifier
The following table shows the resource identifier for the global group required to remove users to the specified group in the request URL.
| Resource Identifier | Required | Description | Type |
|---|---|---|---|
| <id> | Yes | ID of the global group needed to remove users from. | UUID |
Response Body Parameters
The following table describes the response body parameters.
| Parameter | Description | Data Type |
|---|---|---|
| id | Unique identifier that represents the updated global group. | UUID |
Example Response Body
The following is an example response body.
{
"id": "f6b0b45e-a0d6-2864-7ee5-71a9806977cc"
}
Response Codes
The following table lists the response codes and their descriptions for this API.
| HTTP Status Code | Description |
|---|---|
| 200 | Global group users removed successfully. |
| 400 | Operation not performed because of client syntax errors. |
| 403 | Not authorized to perform the request. |
| 429 | Too many requests. |
| 500 | Internal error occurred when processing the request. |
List Global Group Users
The following information describes how to return a paginated list of global group users based on the specified page number and page size.
Prerequisite: An administrator needs the rsa.group.users.read OAuth permission to use this endpoint.
Request Requirements
Use the following information to return a paginated list of global group users based on the specified page number and page size.
| Method | Request URL | Response Content Type | Response Body |
|---|---|---|---|
| GET | /AdminInterface/restapi/v1/localGroups/users/{id} | application/json | List of global group objects containing metadata about the returned global group users. |
Resource Identifiers
The following table shows the resource identifiers for the global group and pagination details that are required in the request URL to retrieve its users.
| Resource Identifier | Required | Description | Type | Default Value | Example Value |
|---|---|---|---|---|---|
| <id> | Yes | ID of the global group needed to find its users | UUID | N/A | N/A |
| <pageSize> | No | Specifies the maximum number of matching results to return. Valid values are 1 to 10, inclusive. | Integer | 5 | 10 |
| <pageNumber> | No | Zero-based index of the page to return. | Integer | 0 | 5 |
Response Body Parameters
The following table describes the response body parameters.
| Parameter | Description | Data Type |
|---|---|---|
| totalPages | Total number of group pages returned by the query. | Integer |
| totalGroups | Total number of groups returned by the query. | Integer |
| users | List containing the global group users returned by the query. | List |
| groups | List containing the groups returned by the query. | List |
| id | Unique identifier that represents the global group. | UUID |
| name | Name of the global group. | String |
| description | Description of the global group. | String |
| readOnly | Flag that indicates that this group is created and managed internally in the system. | Boolean |
| createdAt | Date that the global group has been created. | Timestamp |
updatedAt | Date that the global group has been updated. | Timestamp |
| id | Unique identifier that represents the global group user. | String |
| emailAddress | User's email address. | String |
| firstName | User's first name. | String |
| lastName | User's last name. | String |
Example Response Body
The following is an example response body.
{
"group": {
"id": "7dd8bf57-b615-30fb-889a-bd08491a6461",
"name": "Group 1",
"description": "Group 1 description",
"readOnly": false,
"createdAt": "2024-12-30T10:18:10.587Z",
"updatedAt": "2024-12-30T10:48:13.168Z"
},
"users": [
{
"id": "0064ec40-498f-9273-58de-4119ac5024b9",
"emailAddress": "user1@mycompany.com",
"firstName": "user",
"lastName": "1"
},
{
"id": "01808d52-bea1-0408-e3b5-ba3f12bce78c",
"emailAddress": "user2@mycompany.com",
"firstName": "user",
"lastName": "2"
},
{
"id": "027bbdcc-713b-7670-6904-87f746f3a08c",
"emailAddress": "user3@mycompany.com",
"firstName": "user",
"lastName": "3"
},
{
"id": "04280576-fb25-09ee-0e3c-631a055bcdb2",
"emailAddress": "user4@mycompany.com",
"firstName": "user",
"lastName": "4"
}
],
"totalUsers": 4,
"totalPages": 1
}
Response Codes
The following table lists the response codes and their descriptions for this API.
| HTTP Status Code | Description |
|---|---|
| 200 | Global group user list retrieved successfully. |
| 400 | Operation not performed because of client syntax errors. |
| 403 | Not authorized to perform the request. |
| 429 | Too many requests. |
| 500 | Internal error occurred when processing the request. |
For more information, see Cloud Administration Global Groups API .
Related Articles
Cloud Administration Global Groups API Number of Views Cloud Administration APIs Number of Views Manage User Groups in the Cloud Administration Console Number of Views Accessing the Cloud Administration APIs Number of Views Download RSA SecurID Access Cloud User Event audit logs using Cloud Administration REST API CLU Number of Views
Trending Articles
RSA SecurID software token .sdtid file fails to import into RSA SecurID Software Token 5.0 for Windows RSA Announces the Release of RSA MFA Agent 2.5 for Microsoft Windows RSA MFA Agent 2.5 for Microsoft Windows Installation and Administration Guide How to manipulate imported RSA SecurID Software Token(s) on an iPhone or iPad device How to generate a PASSCODE for manual entry on a Ericsson R380 WAP phone
