Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
服务账户
/
组织帐户

获取一个服务帐户

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应元素
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}

请求路径参数

名称
类型
说明

ORG-ID

字符串

要检索其服务帐户的组织的唯一标识符。使用 /orgs 端点检索经过身份验证的用户有权访问权限的所有组织。

CLIENT-ID

字符串

要检索的服务帐户的唯一标识符。请求 /orgs/{ORG- ID}/serviceAccounts 端点检索经过身份验证的用户有权访问权限的指定组织的所有服务帐户。

请求查询参数

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

名称
类型
说明
默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

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

100

pretty

布尔

指示响应正文是否应采用 美观打印 格式。

false

envelope

布尔

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 "envelope" : true。

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

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

无

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应元素

如果将查询元素envelope设置为true ，则响应将由content对象包装。

HTTP 响应返回一个 JSON document，其中包含以下对象：

名称
类型
说明

clientId

字符串

服务帐户的唯一标识符。

description

字符串

服务帐户的描述。 接受的字符包括 A-Z 、 a-z 、 0-9 、空格、句点 . 、撇号 ' 、逗号 , 、下划线 _ 和破折号 - 。

name

字符串

服务帐户名称。 接受的字符包括 A-Z 、 a-z 、 0-9 、空格、句点 . 、撇号 ' 、逗号 , 、下划线 _ 和破折号 - 。

createdAt

timestamp

服务帐户创建时间。

secrets

对象数组

服务帐户密钥列表。

secrets.id

字符串

24string标识密钥的唯一 -十六进制字符串。

secrets.secret

字符串

服务帐户密钥，仅在创建时可用。

secrets.maskedSecretValue

字符串

仅显示前缀和最后四个字符的掩码密钥。

secrets.createdAt

timestamp

表示密钥创建时间的时间戳。

secrets.lastUsedAt

timestamp

表示上次密钥使用情况的时间戳。

secrets.expiresAt

timestamp

表示密钥过期时间的时间戳。

roles

对象数组

服务帐户在组织中具有的角色。

组织角色包括：

请求示例

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

响应示例

响应标头

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 200 OK
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}

响应体

{
 "createdAt" : "2024-05-31T17:27:05Z",
 "description" : "This service account is for admins.",
 "clientId" : "mdb_sa_id_665a086958c92d31a28d452e",
 "name" : "Admin Service Account",
 "roles" : [ "ORG_OWNER" ],
 "secrets" : [ {
   "createdAt" : "2024-05-31T17:27:05Z",
   "expiresAt" : "2025-05-31T17:27:05Z",
   "id" : "665a086958c92d31a28d452f",
   "maskedSecretValue" : "mdb_sa_sk_…OEyV"
  } ]
}

后退

获取全部

来年

获取所有作业