---
updatedAt: 2026-07-02T14:47:16.000Z
---

# List PAM Integrations

Retrieves a paginated list of PAM integrations with optional filtering

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-explorer-enabled": false,
  "info": {
    "title": "Site API (Legacy)",
    "license": {
      "name": "(c) Copyright 2021 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/pam_integration": {
      "get": {
        "description": "Retrieves a paginated list of PAM integrations with optional filtering",
        "operationId": "listPAMIntegrations",
        "parameters": [
          {
            "description": "Filter by client ID",
            "in": "query",
            "name": "client_id",
            "schema": {
              "type": "integer",
              "example": 123
            }
          },
          {
            "description": "Number of results to return",
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "example": 10
            }
          },
          {
            "description": "Pagination offset",
            "in": "query",
            "name": "offset",
            "schema": {
              "type": "integer",
              "default": 0,
              "example": 0
            }
          },
          {
            "description": "Sort field (prefix with \"-\" for descending)",
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string",
              "enum": [
                "name",
                "-name",
                "pam_endpoint",
                "-pam_endpoint"
              ],
              "default": "name",
              "example": "name"
            }
          },
          {
            "description": "The response representation format for results.",
            "in": "query",
            "name": "format",
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of PAM integrations",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PAMIntegrationList"
                },
                "example": {
                  "pam_integrations": [
                    {
                      "pam_authentication_method": "app_role",
                      "pam_endpoint": "https://vault.prod.acme.com:8200",
                      "name": "Production Vault Integration",
                      "identifier": "prod-role-id-xyz789",
                      "identifier_secret": null,
                      "pam_auth_type": "Vault",
                      "pam_auth_type_id": 3,
                      "client_id": 50,
                      "id": 201,
                      "organization": "Acme Corporation",
                      "namespace": "admin/production"
                    },
                    {
                      "id": 202,
                      "client_id": 50,
                      "organization": "Acme Corporation",
                      "identifier_secret": null,
                      "identifier": null,
                      "pam_auth_type_id": 2,
                      "pam_auth_type": "Boundary",
                      "pam_endpoint": "https://boundary.staging.acme.com:9200",
                      "name": "Staging Boundary Access",
                      "pam_authentication_method": "token"
                    },
                    {
                      "organization": "Acme Corporation",
                      "name": "Dev Boundary Credentials",
                      "pam_authentication_method": "credentials",
                      "client_id": 50,
                      "id": 203,
                      "pam_authentication_method_id": "ampw_9z8y7x6w5v",
                      "pam_auth_type_id": 2,
                      "pam_auth_type": "Boundary",
                      "identifier": "dev-admin@acme.com",
                      "identifier_secret": null,
                      "pam_endpoint": "https://boundary.dev.acme.com:9200"
                    }
                  ],
                  "page": {
                    "filteredCount": 3,
                    "offset": 0,
                    "limit": null,
                    "totalCount": 25
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestError"
                },
                "example": {
                  "error": "Invalid sort field: invalid_field",
                  "status": 400
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - Access denied",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenError"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServerError"
                }
              }
            }
          }
        },
        "summary": "List PAM Integrations",
        "tags": [
          "PAM Integration API v1.0"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "required": [
          "error",
          "status"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Error message describing what went wrong"
          },
          "status": {
            "type": "integer",
            "description": "HTTP status code"
          }
        }
      },
      "BadRequestError": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Error"
          },
          {
            "type": "object",
            "example": {
              "error": "Missing or empty required field: name",
              "status": 400
            }
          }
        ]
      },
      "ForbiddenError": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Error"
          },
          {
            "type": "object",
            "example": {
              "error": "Access denied",
              "status": 403
            }
          }
        ]
      },
      "InternalServerError": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Error"
          },
          {
            "type": "object",
            "example": {
              "error": "Internal server error",
              "status": 500
            }
          }
        ]
      },
      "PAMIntegration": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 453
          },
          "name": {
            "type": "string",
            "example": "Staging Boundary API"
          },
          "pam_endpoint": {
            "type": "string",
            "example": "https://boundary.staging.acme.com:9200"
          },
          "pam_authentication_method": {
            "type": "string",
            "enum": [
              "token",
              "credentials",
              "app_role"
            ],
            "example": "token"
          },
          "pam_authentication_method_id": {
            "type": "string",
            "nullable": true,
            "description": "Auth method ID. Present for credentials, null otherwise",
            "example": null
          },
          "namespace": {
            "type": "string",
            "nullable": true,
            "description": "Namespace path. Present for app_role, null otherwise",
            "example": null
          },
          "organization": {
            "type": "string",
            "example": "Acme Corporation"
          },
          "client_id": {
            "type": "integer",
            "example": 789
          },
          "pam_auth_type": {
            "type": "string",
            "enum": [
              "Boundary",
              "Vault"
            ],
            "example": "Boundary"
          },
          "pam_auth_type_id": {
            "type": "integer",
            "description": "2 for Boundary, 3 for Vault",
            "example": 2
          },
          "identifier_secret": {
            "type": "string",
            "nullable": true,
            "description": "Always null in responses",
            "example": null
          },
          "identifier": {
            "type": "string",
            "nullable": true,
            "description": "Username (credentials), role ID (app_role), or null (token)",
            "example": null
          }
        }
      },
      "PAMIntegrationList": {
        "type": "object",
        "properties": {
          "pam_integrations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PAMIntegration"
            }
          },
          "page": {
            "type": "object",
            "properties": {
              "filteredCount": {
                "type": "integer",
                "description": "Number of PAM integrations matching the filter",
                "example": 3
              },
              "offset": {
                "type": "integer",
                "description": "Pagination offset",
                "example": 0
              },
              "limit": {
                "type": "integer",
                "nullable": true,
                "description": "Number of results per page (null if not specified)",
                "example": null
              },
              "totalCount": {
                "type": "integer",
                "description": "Total number of PAM integrations for accessible clients",
                "example": 25
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "proxy-enabled": true
  }
}
```