PAM360 REST API

PAM360 REST API 通过允许外部系统安全地连接、交互并自动化执行 PAM360 内的操作，实现了应用程序之间的无缝集成。这些 API 遵循表示状态转移（REST）架构风格，并使用标准的 HTTP 方法以编程方式执行操作。 PAM360 支持 120 多个 REST API，提供了涵盖资源管理、账户管理、密码操作、访问控制、用户和组管理、证书和密钥管理等领域的广泛功能，使其非常适合企业级自动化和编排。

使用 PAM360 REST API，您可以：

• 创建和管理资源及账户
• 添加和管理 SSL 证书及 SSH 密钥
• 将 SSH 密钥与资源关联
• 安全地检索密码及资源/账户详细信息
• 通过编程方式更新密码
• 与用户或用户组共享资源和账户
• 将 PAM360 与第三方工具、脚本和工作流集成

1. 先决条件

要调用任何 PAM360 API，您应在 PAM360 中创建一个 API 用户账户。如果为该 API 用户账户启用了主机名验证，PAM360 将验证每个传入 API 请求的主机名，并仅在主机名与该 API 用户账户配置的主机名匹配时处理该请求。

创建 API 用户账户后，该用户应通过 PAM360 用户界面或使用 “重新生成 API” ，才能访问 API。每个 API 用户账户的 AUTHTOKEN 均具有唯一性，且为必填项。该令牌应包含在请求头中，以对所有 PAM360 API 请求进行身份验证。

2. 支持的 HTTP 方法

PAM360 REST API 支持以下 HTTP 方法：

• GET - 检索资源、账户、密码、详细信息等
• POST - 创建新的资源、账户、关联、配置等
• PUT - 更新现有实体，例如更改密码、详细信息、配置等
• DELETE - 从 PAM360 中删除资源、账户、关联或配置。

3. 调用 API

所有 PAM360 REST API 均通过标准 HTTP 请求调用，并需满足以下关键要求：

• 请求应使用 GET、POST 或 PUT 方法发送
• 请求参数应采用表单 URL 编码
• 请求头中应包含 PAM360 身份验证令牌

4. 支持的格式

示例 URL 结构

https://<PAM360-主机名-或-IP>:<端口>/restapi/json/v1/resources/<资源ID>/accounts/<账户ID>

示例请求头

AUTHTOKEN=<生成的 PAM360 授权令牌>

5. API 组织与文档结构

所有 PAM360 REST API 均按模块和 CRUD 操作进行清晰分类，便于查找和使用。如导航菜单所示，API 被归类到以下逻辑部分：

• 身份验证与安全
• 资源管理
• 资源组管理
• 账户管理
• 密码管理
• 访问控制
• 用户管理
• 用户组管理
• SSH 和 PGP 密钥
• SSL 证书

每个 API 部分提供：

• 清除端点定义
• 描述性输入参数
• 使用 cURL、Python 和 PowerShell 的请求示例
• 详细的响应示例

{
  "operation":{
    "result":{
      "message":"收到的 API 密钥未与任何用户关联。认证失败。",
      "status":"Failed",
      "statusCode":40018
    },
    "name":"Authentication"
  }
}

{
  "operation":{
    "result":{
      "message":"用户不允许从此主机访问",
      "status":"失败",
      "statusCode":40030
    },
    "name":"身份验证"
  }
}

{
  "operation":{
    "result":{
      "message":"请使用身份验证令牌再生 API 重新生成您的身份验证令牌，以便使用后续的 PAM360 API。",
      "status":"Failed",
      "statusCode":40035
    },
    "name":"身份验证"
  }
}

{
	"operation":{
    "result":{
        "message":"未授权访问 - 您无权执行此操作。此事件将被审计。",
        "status":"失败",
        "statusCode":40003
    },
    "name":SHARE_RESOURCE(S)
    }
}