---
updatedAt: 2026-05-12T09:59:43.000Z
---

# Retrieve primary clients for all users

This operation returns an object containing primary client information
for all users that the current user has permission to view and manage.

# OpenAPI definition

```json
{
  "components": {
    "responses": {
      "BadRequestResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        },
        "description": "BadRequestResponse indicates a request with invalid parameters"
      },
      "ForbiddenResponse": {
        "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
      },
      "GenericError": {
        "description": "GenericError generic error"
      },
      "UnauthorizedResponse": {
        "description": "UnauthorizedResponse signals an unauthorized API access"
      },
      "UserClientsResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/userClientsMessage"
            }
          }
        },
        "description": "UserClientsResponse provides Primary Client information for those users\nan admin has access to"
      }
    },
    "schemas": {
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "UserClient": {
        "description": "UserClient data is returned by the userClients endpoint",
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "userClientsMessage": {
        "properties": {
          "collection": {
            "description": "Collection of users a user has access to view",
            "items": {
              "$ref": "#/components/schemas/UserClient"
            },
            "type": "array"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2022 WhiteHat Security"
    },
    "title": "Access Control Management API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/userClients": {
      "get": {
        "description": "This operation returns an object containing primary client information\nfor all users that the current user has permission to view and manage.",
        "operationId": "userClients",
        "responses": {
          "200": {
            "$ref": "#/components/responses/UserClientsResponse"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestResponse"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedResponse"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenResponse"
          },
          "500": {
            "$ref": "#/components/responses/GenericError"
          }
        },
        "summary": "Retrieve primary clients for all users",
        "tags": [
          "Access Control Management API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Access Control Management API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```