Using Cloudsoc APIs get the list of users who are members of a certain Cloudsoc Group.
search cancel

Using Cloudsoc APIs get the list of users who are members of a certain Cloudsoc Group.

book

Article ID: 271704

calendar_today

Updated On:

Products

CASB Gateway Advanced CASB Security Advanced CASB Security Premium CASB Security Standard

Issue/Introduction

Cloudsoc User Management API's lists the users with their group membership, in some use cases, it is more efficient to query for the Cloudsoc Group to get the Members (users) of the group.

This article clarify a new API Endpoint that addresses this use case.

Resolution

Use this API Endpoing:

/api/admin/v1/usergroups_management/?group_name=<group_name>

 

Example:

To query for a cloudsoc group named "Finance", the query will be:

/api/admin/v1/usergroups_management/?group_name=Finance

 

Assuming this group contains only one user (user0000), the response will look like this:

{
    "meta": {
        "limit": 200,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects"
    : [{
            "created_by": "[email protected]",
            "created_on": "2023-01-01T00:00:00.000000",
            "group_name": "Finance",
            "modified_by": <user name if modified>,
            "modified_on": <date if modified>,

            "user_email": "[email protected]"
            "user_id": "000011112222333344445555"
        }
    ]
}