/ /

/ /

创建服务帐户密钥

基本 URL： https://cloud.mongodb.com/api/public/v1.0

Resource

POST /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/secrets/

请求路径参数

名称	类型	说明
`ORG-ID`	字符串	目标服务帐户所属组织的唯一标识符。使用 /orgs 端点检索经过身份验证的用户有权访问权限的所有组织。
`CLIENT-ID`	字符串	要为其创建密钥的服务帐户的唯一标识符。请求 /groups/{PROJECT- ID}/serviceAccounts 端点检索经过身份验证的用户有权访问权限的指定组织的所有服务帐户。

请求查询参数

以下查询参数为可选参数：

名称

类型

说明

默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

每页要返回的项目数，最多 500 个。

100

pretty

布尔

指示显示正文是否应采用 prettyprint 格式。

false

envelope

布尔

指示是否要将响应封装在信封中。

Some API clients cannot access the HTTP response headers or status code. To remediate this, set "envelope" : true in the query.

对于返回一个结果的终结点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

对于返回结果列表的端点，results 对象是一个信封。Cloud Manager 将 status 字段添加到响应正文。

无

请求正文参数

此正文参数为必填项。

名称	类型	说明
`secretExpiresAfterHours`	字符串	此服务帐户的密钥过期的小时数。最短时间为 8 小时。最大值为 8766 小时（一年）。

响应

名称	类型	说明
`id`	字符串	24string标识密钥的唯一 -十六进制字符串。
`secret`	字符串	服务帐户密钥，仅在创建时可用。
`createdAt`	timestamp	表示创建时间的时间戳。
`expiresAt`	timestamp	表示密钥过期时间的时间戳。

请求示例

注意

发出请求的用户可以采用{PUBLIC-KEY}:{PRIVATE-KEY}格式。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/secrets/?pretty=true" \
     --data '{
      "secretExpiresAfterHours": "3600"
     }'

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

注意

响应正文中的 secret 未编辑。出于安全目的，此示例已编辑。

{
  "createdAt" : "2024-08-08T22:19:45Z",
  "expiresAt" : "2025-01-05T22:19:45Z",
  "id" : "66b544825867ba071c85469d",
  "secret" : "mdb_sa_sk_...AOk5"
}