Get Groups
GET/api/v33.02/groups
x-prisma-cloud-target-env: {"permission":"userManagement"}
Retrieves the list of all groups.
This endpoint maps to the table data on the Manage > Authentication > Groups Console UI page.
cURL Request
Refer to the following example cURL command that retrieves all the system groups.
$ curl -k \
-X GET \
-u <USER> \
-H 'Content-Type: application/json' \
https://<CONSOLE>/api/v<VERSION>/groups
Responses
- 200
- default
Groups represents a list of groups
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
Group name.
Group identifier in the Azure SAML identification process.
Group name.
Datetime when the group was created or last modified.
Indicates if the group is an LDAP group (true) or not (false).
Indicates if the group is an OAuth group (true) or not (false).
Indicates if the group is an OpenID Connect group (true) or not (false).
User who created or modified the group.
permissions object[]
Permissions is a list of permissions
List of collections the user can access.
Names of projects which the user can access.
Role of the group.
Indicates if the group is a SAML group (true) or not (false).
user object[]
Users in the group.
Name of a user.
[
{
"_id": "string",
"groupId": "string",
"groupName": "string",
"lastModified": "2024-07-29T15:51:28.071Z",
"ldapGroup": true,
"oauthGroup": true,
"oidcGroup": true,
"owner": "string",
"permissions": [
{
"collections": [
"string"
],
"project": "string"
}
],
"role": "string",
"samlGroup": true,
"user": [
{
"username": "string"
}
]
}
]