Add a Group
POST/api/v33.02/groups
x-prisma-cloud-target-env: {"permission":"userManagement"}
Creates a group with users.
To invoke this endpoint in the Console UI:
- Navigate to Manage > Authentication > Groups.
- Add a collection using + Add group.
- Enter a group name and add at least one user.
- Click the Save button.
cURL Request
Refer to the following example cURL command that creates a new group named my-group
:
$ curl -k \
-X POST \
-u <USER> \
-H 'Content-Type: application/json' \
-d \
'{
"groupName": "my-group",
"user": [
{"username": "john"},
{"username": "jane"}
]
}' \
'https://<CONSOLE>/api/v<VERSION>/groups'
This group includes the users associated with the usernames john
and jane
.
Note: You must use usernames that already exist in the system.
No response will be returned upon successful execution.
Request
- application/json
Body
- 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.
Responses
- 200
- default
OK