User Groups
Operations for managing user groups including creation, editing, deletion, and listing user groups.
This endpoint retrieves a list of user groups and returns their attributes. For possible 'group_type' values, please refer to the enum documentation for 'GroupType'. Also, 'nested_groups' refers to the list of direct child groups of the given user group. Similarly, 'idp_groups' refers to the identifiers of associated identity provider groups to the given user group.
Successfully retrieved user groups
Unauthorized access
Unauthorized access due to lack of sufficient permissions. This includes Instance Administrator privilege escalation errors: non-admin API keys cannot assign, modify, or delete entities that have the Instance Administrator role.
Internal server error. A unified status for API communication type errors.
GET /platform/iam/v1/user-group HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Accept: */*
{
"data": [
{
"group_id": "test_group1",
"group_name": "Group2",
"description": null,
"role_id": "role_name01",
"pretty_role_name": "Role Name 01",
"created_by": "user1@test.com",
"created_ts": 1661170832341,
"updated_ts": 1661171650679,
"users": [
"user1@test.com",
"user2@test.com",
"user3@test.com",
"user4@test.com",
"user5@test.com"
],
"group_type": "custom",
"nested_groups": [
{
"group_id": "abc_123",
"group_name": "child-group-name1"
}
],
"idp_groups": [
"test_idp_group_name"
]
}
],
"metadata": {
"total_count": 1
}
}This endpoint creates a new user group with the specified configuration. You can assign a role, add users, configure nested groups, and link identity provider groups. All fields except 'group_name' are optional.
Request object for creating a new user group
User Group created successfully
Bad request for user group create call
Unauthorized access
Unauthorized access due to lack of sufficient permissions. This includes Instance Administrator privilege escalation errors: non-admin API keys cannot assign, modify, or delete entities that have the Instance Administrator role.
Internal server error. A unified status for API communication type errors.
POST /platform/iam/v1/user-group HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Content-Type: application/json
Accept: */*
Content-Length: 231
{
"request_data": {
"group_name": "test_group_name",
"role_id": "role_name_123",
"description": "Test Description",
"users": [
"user1@test.com"
],
"nested_group_ids": [
"7f3o5b2c-4d5e-4f6a-8b9c-1d3o5f4a5b6c_123"
],
"idp_groups": [
"test idp group"
]
}
}{
"data": {
"message": "user group with group id 123-456 created successfully"
}
}Delete an existing user group. Note: upon deletion of a user group, its nested groups are not deleted; the relationships are simply removed.
Full user group id
7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123User Group deleted successfully
Bad request for user group delete call
Unauthorized access
Unauthorized access due to lack of sufficient permissions. This includes Instance Administrator privilege escalation errors: non-admin API keys cannot assign, modify, or delete entities that have the Instance Administrator role.
Internal server error. A unified status for API communication type errors.
DELETE /platform/iam/v1/user-group/{group_id} HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Accept: */*
{
"data": {
"message": "user group with group id 7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123 deleted successfully"
}
}This endpoint allows modification of an existing user group by providing the group_id in the path and the update details in the request body. Only specified fields will be updated. Please note that to remove attributes, you must provide either an empty string or empty list as the value of the respective field in the request body.
Full user group id
7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123Request object for editing an existing user group
User Group edited successfully
Bad request for user group edit call
Unauthorized access
Unauthorized access due to lack of sufficient permissions. This includes Instance Administrator privilege escalation errors: non-admin API keys cannot assign, modify, or delete entities that have the Instance Administrator role.
Internal server error. A unified status for API communication type errors.
PATCH /platform/iam/v1/user-group/{group_id} HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Content-Type: application/json
Accept: */*
Content-Length: 234
{
"request_data": {
"group_name": "test_group_name",
"role_id": "role_name_123",
"description": "Test Updated Description",
"users": [
"test user"
],
"nested_group_ids": [
"7f3o5b2c-4d5e-4f6a-8b9c-1d3o5f4a5b6c_123"
],
"idp_groups": [
"test idp group"
]
}
}{
"data": {
"message": "user group with group id 123-456 updated successfully"
}
}Last updated
Was this helpful?