Get Groups

GET 
/api/v32.04/groups

x-prisma-cloud-target-env: {"permission":"userManagement","saas":true,"self-hosted":true}
x-public: true

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

Groups represents a list of groups

application/json

Schema

Schema

• Array [
_id string

Group name.

groupId string

Group identifier in the Azure SAML identification process.

groupName string

Group name.

lastModified date-time

Datetime when the group was created or last modified.

ldapGroup boolean

Indicates if the group is an LDAP group (true) or not (false).

oauthGroup boolean

Indicates if the group is an OAuth group (true) or not (false).

oidcGroup boolean

Indicates if the group is an OpenID Connect group (true) or not (false).

owner string

User who created or modified the group.

permissions object[]
Permissions is a list of permissions
Array [
collections string (string)[]
List of collections the user can access.
project string
Names of projects which the user can access.
]
role string

Role of the group.

samlGroup boolean

Indicates if the group is a SAML group (true) or not (false).

user object[]
Users in the group.
Array [
username string
Name of a user.
]
• ]

Example (from schema)

[
  {
    "_id": "string",
    "groupId": "string",
    "groupName": "string",
    "lastModified": "2024-04-25T18:28:17.140Z",
    "ldapGroup": true,
    "oauthGroup": true,
    "oidcGroup": true,
    "owner": "string",
    "permissions": [
      {
        "collections": [
          "string"
        ],
        "project": "string"
      }
    ],
    "role": "string",
    "samlGroup": true,
    "user": [
      {
        "username": "string"
      }
    ]
  }
]

default

Loading...