Get Users

GET 
/api/v33.01/users

x-prisma-cloud-target-env: {"permission":"userManagement"}

Retrieves a list of all users.

This endpoint maps to Manage > Authentication > Users in the Console UI.

cURL Request

The following cURL command retrieves all users.

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  'https://<CONSOLE>/api/v<VERSION>/users'

A successful response returns a list of all users.

Responses

200

UserList represents a list of users

application/json

Schema

Schema

• Array [
authType api.AuthType (string)

Possible values: [saml,ldap,basic,oauth,oidc]

AuthType is the user authentication type

lastModified date-time

Datetime when the user was created or last modified.

password string

Password for authentication.

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

User role.

username string

Username for authentication.

• ]

Example (from schema)

[
  {
    "authType": [
      "saml",
      "ldap",
      "basic",
      "oauth",
      "oidc"
    ],
    "lastModified": "2024-07-29T15:51:28.071Z",
    "password": "string",
    "permissions": [
      {
        "collections": [
          "string"
        ],
        "project": "string"
      }
    ],
    "role": "string",
    "username": "string"
  }
]

default

Loading...