获取分配给一个项目的所有组织服务帐户

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
响应文档
results 嵌入式文档
请求示例
响应示例
响应标头
响应体

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth2.0 身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

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

Resource

GET /groups/{PROJECT-ID}/serviceAccounts

请求路径参数

名称	类型	说明
`PROJECT-ID`	字符串	要从中检索分配的组织服务帐户的项目的唯一标识符。使用 /groups 端点检索经过身份验证的用户有权访问权限的所有项目。

请求查询参数

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

名称

类型

说明

默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

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

100

pretty

布尔

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

false

envelope

布尔

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

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

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

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

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

无

请求正文参数

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

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称	类型	说明
`results`	阵列	数组为`results`嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

每个结果都是一个 Project 服务帐户。

名称	类型	说明
`clientId`	字符串	服务帐户的唯一标识符。
`createdAt`	timestamp	服务帐户创建时间。
`name`	字符串	服务帐户名称。
`description`	字符串	服务帐户的描述。
`roles`	字符串数组	服务帐户在项目中具有的角色列表。项目角色包括： `GROUP_AUTOMATION_ADMIN` `GROUP_BACKUP_ADMIN` `GROUP_BILLING_ADMIN` `GROUP_DATA_ACCESS_ADMIN` `GROUP_DATA_ACCESS_READ_ONLY` `GROUP_DATA_ACCESS_READ_WRITE` `GROUP_MONITORING_ADMIN` `GROUP_OWNER` `GROUP_READ_ONLY` `GROUP_USER_ADMIN`
`secrets`	对象数组	服务帐户密钥列表。
`secrets.id`	字符串	24string标识密钥的唯一 -十六进制字符串。
`secrets.createdAt`	timestamp	表示密钥创建时间的时间戳。
`secrets.expiresAt`	timestamp	表示密钥过期时间的时间戳。
`secrets.lastUsedAt`	timestamp	表示上次密钥使用情况的时间戳。
`secrets.maskedSecretValue`	字符串	仅显示前缀和最后四个字符的掩码密钥。

请求示例

注意

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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?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}

响应体

1 {
2   "links": [
3     {
4       "href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100",
5       "rel": "self"
6     }
7   ],
8   "results": [
9     {
10       "createdAt": "2024-08-03T14:02:40Z",
11       "description": "Service account for Cloud Manager users.",
12       "clientId": "mdb_sa_id_66ae38803cdf55582cb01144",
13       "name": "General Access",
14       "roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"],
15       "secrets": [
16         {
17           "createdAt": "2024-08-03T14:02:40Z",
18           "expiresAt": "2024-12-31T14:02:40Z",
19           "lastUsedAt" : "2024-08-24T21:10:35Z",
20           "id": "66ae38803cdf55582cb01143",
21           "maskedSecretValue": "mdb_sa_sk_...hcOL"
22         }
23       ]
24     },
25     {
26       "createdAt": "2024-08-03T14:05:20Z",
27       "description": "Service account for read access.",
28       "clientId": "mdb_sa_id_66ae38803cdf55582cb01145",
29       "name": "Read Only Access",
30       "roles": ["GROUP_READ_ONLY"],
31       "secrets": [
32         {
33           "createdAt": "2024-08-03T14:05:20Z",
34           "expiresAt": "2024-12-31T14:05:20Z",
35           "lastUsedAt" : "2024-08-24T21:10:35Z",
36           "id": "66ae38803cdf55582cb01146",
37           "maskedSecretValue": "mdb_sa_sk_...jcOP"
38         }
39       ]
40     },
41     {
42       "createdAt": "2024-08-03T14:10:00Z",
43       "description": "Service account for data backup.",
44       "clientId": "mdb_sa_id_66ae38803cdf55582cb01147",
45       "name": "Backup Access",
46       "roles": ["GROUP_DATA_BACKUP_ADMIN"],
47       "secrets": [
48         {
49           "createdAt": "2024-08-03T14:10:00Z",
50           "expiresAt": "2024-12-31T14:10:00Z",
51           "lastUsedAt" : "2024-08-24T21:10:35Z",
52           "id": "66ae38803cdf55582cb01148",
53           "maskedSecretValue": "mdb_sa_sk_...kcQR"
54         }
55       ]
56      }
57    ],
58   "totalCount": 3
59 }

后退

项目服务帐户

来年

获取一个项目服务帐户

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"

1	{
2	"links": [
3	{
4	"href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100",
5	"rel": "self"
6	}
7	],
8	"results": [
9	{
10	"createdAt": "2024-08-03T14:02:40Z",
11	"description": "Service account for Cloud Manager users.",
12	"clientId": "mdb_sa_id_66ae38803cdf55582cb01144",
13	"name": "General Access",
14	"roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"],
15	"secrets": [
16	{
17	"createdAt": "2024-08-03T14:02:40Z",
18	"expiresAt": "2024-12-31T14:02:40Z",
19	"lastUsedAt" : "2024-08-24T21:10:35Z",
20	"id": "66ae38803cdf55582cb01143",
21	"maskedSecretValue": "mdb_sa_sk_...hcOL"
22	}
23	]
24	},
25	{
26	"createdAt": "2024-08-03T14:05:20Z",
27	"description": "Service account for read access.",
28	"clientId": "mdb_sa_id_66ae38803cdf55582cb01145",
29	"name": "Read Only Access",
30	"roles": ["GROUP_READ_ONLY"],
31	"secrets": [
32	{
33	"createdAt": "2024-08-03T14:05:20Z",
34	"expiresAt": "2024-12-31T14:05:20Z",
35	"lastUsedAt" : "2024-08-24T21:10:35Z",
36	"id": "66ae38803cdf55582cb01146",
37	"maskedSecretValue": "mdb_sa_sk_...jcOP"
38	}
39	]
40	},
41	{
42	"createdAt": "2024-08-03T14:10:00Z",
43	"description": "Service account for data backup.",
44	"clientId": "mdb_sa_id_66ae38803cdf55582cb01147",
45	"name": "Backup Access",
46	"roles": ["GROUP_DATA_BACKUP_ADMIN"],
47	"secrets": [
48	{
49	"createdAt": "2024-08-03T14:10:00Z",
50	"expiresAt": "2024-12-31T14:10:00Z",
51	"lastUsedAt" : "2024-08-24T21:10:35Z",
52	"id": "66ae38803cdf55582cb01148",
53	"maskedSecretValue": "mdb_sa_sk_...kcQR"
54	}
55	]
56	}
57	],
58	"totalCount": 3
59	}