User
Operations for managing users including listing users and editing user configurations.
This endpoint retrieves a list of all users and their respective properties. Note: the 'role_name' field refers to the 'pretty_name' attribute from the Roles APIs and the direct role assigned to the user, not roles inherited through groups.
Successfully retrieved users
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 HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Accept: */*
{
"data": [
{
"user_email": "user1@test.com",
"user_first_name": "<first name>",
"user_last_name": "<last name>",
"phone_number": "408-753-4000",
"role_name": "Investigator",
"status": "Active",
"last_logged_in": 1640024700241,
"is_hidden": true,
"user_type": "CSP",
"groups": [
{
"group_id": 123,
"group_name": "usergroup1"
}
]
},
{
"user_email": "user2@test.com",
"user_first_name": "<first name>",
"user_last_name": "<last name>",
"phone_number": "408-753-4000",
"status": "Active",
"role_name": "Investigator",
"last_logged_in": 1640024700241,
"is_hidden": true,
"user_type": "CSP",
"groups": [
{
"group_id": 123,
"group_name": "usergroup2"
}
]
}
],
"metadata": {
"total_count": 2
}
}This endpoint retrieves a user and its respective properties. Note: the 'role_name' field refers to the 'pretty_name' attribute from the Roles APIs, not the unique role identifier.
Full email of the user
Successfully retrieved user
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/{user_email} HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Accept: */*
{
"data": {
"user_email": "user@test.com",
"user_first_name": "<first name>",
"user_last_name": "<last name>",
"phone_number": "408-753-4000",
"status": "Active",
"role_name": "Account Admin",
"last_logged_in": 1640024700241,
"is_hidden": true,
"user_type": "CSP",
"groups": [
{
"group_id": "unique_group_id",
"group_name": "usergroup"
}
]
}
}This endpoint allows updating various user details. Please note that you must pass an empty string for the 'role_id' field if you are attempting to remove a role from a user. For the 'user_groups' field, please pass an empty list to remove user group associations for the provided user.
Full email of the user
Request object for editing an existing user
User edited successfully
Bad request for user 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/{user_email} HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Content-Type: application/json
Accept: */*
Content-Length: 143
{
"request_data": {
"phone_number": "408-753-4000",
"status": "Active",
"role_id": "role_name_123",
"is_hidden": true,
"user_groups": [
"user_groups_123"
]
}
}{
"data": {
"message": "User updated successfully"
}
}Last updated
Was this helpful?