Managing Local Group Users with the Cloud Administration Local Groups Public API
This topic describes how to:
Note: The administrator should have the appropriate permissions within the OAuth scope to access these endpoints. For more information, see OAuth 2.0-Based Permissions for the Cloud Administration APIs.
Add Users to Local Group
The following information describes how to add user(s) to a local group with the specified id.
Prerequisite: The administrator should have the "rsa.group.users.manage" OAuth permission assigned to use this endpoint.
Request Overview
Use the following information to add user(s) to a local group with the specified id.
| Action | Method | Request URL | Response Content Type | Response Body |
|---|---|---|---|---|
| Adds user(s) to the local group with the specified id. | 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.
| Resource Identifier | Description | Required | Data Type |
|---|---|---|---|
| userIds | List of user ids to add to the local 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"]
}| Request Parameter | Required | Description | Type |
|---|---|---|---|
| <id> | Yes | ID of the local group needed to add users to | UUID |
Response Body Parameters
The following table describes the response body parameters.
| Parameter | Description | Data Type |
|---|---|---|
| id | Unique identifier that represents the local 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 | Local group created 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 Local Group
The following information describes how to remove user(s) from the local group with a specified id.
Prerequisite: The administrator should have the "rsa.group.users.manage" OAuth permission assigned to use this endpoint.
Request Overview
Use the following information to remove user(s) from the local group with a specified id.
| Action | Method | Request URL | Response Content Type | Response Body |
|---|---|---|---|---|
| Removes user(s) from the local group with a specified id. | 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.
| Resource Identifier | Description | Required | Data Type |
|---|---|---|---|
| userIds | List of user ids to remove from the local 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 | Required | Description | Type |
|---|---|---|---|
| <id> | Yes | ID of the local 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 local 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 | Local group created 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 Local Group Users
The following information describes how to return a list of local group users paginated based on the provided page number and page size.
Prerequisite: The administrator should have the "rsa.group.users.read" OAuth permission assigned to use this endpoint.
Request Overview
Use the following information to return a list of local group users paginated based on the provided page number and page size.
| Action | Method | Request URL | Response Content Type | Response Body |
|---|---|---|---|---|
| Returns a list of local group users paginated based on the provided page number and page size. | GET | /AdminInterface/restapi/v1/localGroups/users/{id} | application/json | List of local group objects containing metadata about the returned local group users. |
| Resource Identifier | Required | Description | Type | Default Value | Example Value |
|---|---|---|---|---|---|
| <id> | Yes | ID of the local 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 local group users returned by the query. | List |
| groups | List containing the groups returned by the query. | List |
| id | Unique identifier that represents the local group. | UUID |
| name | Name of the local group. | String |
| description | Description of the local group. | String |
| readOnly | Flag that indicates that this group is created and managed internally in the system. | Boolean |
| createdAt | Date that the local group has been created. | Timestamp |
updatedAt | Date that the local group has been updated. | Timestamp |
| id | Unique identifier that represents the local 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 | Local group created 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. |
Related Articles
Set Restricted Access Times for User Groups Number of Views Edit RADIUS Server Files Number of Views Cloud Administration Local Groups Public API Number of Views Cloud Administration Update Local User API Number of Views RSA Authentication Manager 8.2 SP1 Patch 7 Readme Number of Views
Trending Articles
RSA MFA Agent 2.5 for Microsoft Windows Installation and Administration Guide RSA Release Notes for RSA Authentication Manager 8.8 Troubleshooting RSA MFA Agent for Microsoft Windows How to download and install the AFX Server Archive in RSA Identity Governance & Lifecycle The Template ({Connector Template Name}) has missing file content error when creating AFX Connectors in RSA Identity Gover…
