1 つのプロジェクトに割り当てられたすべての組織の API キーを取得

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

Cloud Manager は、 2024年8月30日で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}/apiKeys

リクエストパスパラメーター

名前	タイプ	説明
`PROJECT-ID`	string	割り当てられた組織 APIキーを取得するプロジェクトの一意の識別子。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groupsエンドポイントを使用します。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体を pretty-print にするかどうかを示します形式。

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

なし

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのプロジェクトAPIキーです。

名前

タイプ

説明

desc

string

このプロジェクトに割り当てられた組織APIキーの説明。

id

string

このプロジェクトに割り当てられた組織APIキーの一意の識別子。

privateKey

string

このプロジェクトに割り当てられた組織APIキーの編集済み秘密キー。

このキーは、最初に作成したときは編集されずに表示されます。

publicKey

string

このプロジェクトに割り当てられた組織APIキーの公開キー。

roles

オブジェクト配列

このプロジェクトに割り当てられたこの組織APIキーが持つロール。この配列は、Cloud Manager でユーザーが持っているすべての組織ロールとプロジェクトロールを返します。

roles.groupId

string

このロールが属するプロジェクトの一意の識別子。

roles.orgId

string

このロールが属する組織の一意の識別子。

roles.roleName

string

ロールの名前。このリソースは、Cloud Managerでユーザーが持っているすべてのロールを返します。可能な値は次のとおりです。

組織ロール

これがroles.orgId （組織）の場合、値には次のものが含まれます。

API のロール値	ロール
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_READ_ONLY`	`Organization Billing Viewer`

プロジェクトロール

これがroles.groupId （プロジェクト）の場合、値には次のものが含まれます。

API のロール値	ロール
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_BILLING_ADMIN`	プロジェクト請求管理者
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`

リクエストの例

注意

リクエストを行うユーザーは、 {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}/apiKeys?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     "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "desc" : "Updated API Key description for DOCSP-6042",
8     "id" : "5d1cf1f980eef570c9fc87e5",
9     "links" : [ {
10       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11       "rel" : "self"
12     } ],
13     "privateKey" : "********-****-****-9d4ae38e4ddd",
14     "publicKey" : "{PUBLIC-KEY}",
15     "roles" : [ {
16       "groupId" : "{PROJECT-ID}",
17       "roleName" : "GROUP_AUTOMATION_ADMIN"
18     }, {
19       "groupId" : "{PROJECT-ID}",
20       "roleName" : "GROUP_MONITORING_ADMIN"
21     }, {
22       "orgId" : "5980cfe20b6d97029d82fa63",
23       "roleName" : "ORG_MEMBER"
24     }, {
25       "orgId" : "5980cfe20b6d97029d82fa63",
26       "roleName" : "ORG_BILLING_ADMIN"
27     }, {
28       "groupId" : "{PROJECT-ID}",
29       "roleName" : "GROUP_DATA_ACCESS_ADMIN"
30     }, {
31       "groupId" : "{PROJECT-ID}",
32       "roleName" : "GROUP_USER_ADMIN"
33     }, {
34       "groupId" : "{PROJECT-ID}",
35       "roleName" : "GROUP_READ_ONLY"
36     }, {
37       "groupId" : "{PROJECT-ID}",
38       "roleName" : "GROUP_OWNER"
39     }, {
40       "orgId" : "5980cfe20b6d97029d82fa63",
41       "roleName" : "ORG_OWNER"
42     }, {
43       "groupId" : "{PROJECT-ID}",
44       "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
45     }, {
46       "orgId" : "5980cfe20b6d97029d82fa63",
47       "roleName" : "ORG_GROUP_CREATOR"
48     }, {
49       "orgId" : "5980cfe20b6d97029d82fa63",
50       "roleName" : "ORG_READ_ONLY"
51     }, {
52       "groupId" : "{PROJECT-ID}",
53       "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54     }, {
55       "groupId" : "{PROJECT-ID}",
56       "roleName" : "GROUP_BACKUP_ADMIN"
57     }, {
58       "groupId" : "{PROJECT-ID}",
59       "roleName" : "GROUP_CLUSTER_MANAGER"
60     } ]
61   }, {
62     "desc" : "New API key for test purposes",
63     "id" : "5d1d12c087d9d63e6d682438",
64     "links" : [ {
65       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
66       "rel" : "self"
67     } ],
68     "privateKey" : "********-****-****-cb34f12aafdb",
69     "publicKey" : "oxhzytwb",
70     "roles" : [ {
71       "groupId" : "{PROJECT-ID}",
72       "roleName" : "GROUP_READ_ONLY"
73     }, {
74       "orgId" : "5980cfe20b6d97029d82fa63",
75       "roleName" : "ORG_MEMBER"
76     }, {
77       "orgId" : "5980cfe20b6d97029d82fa63",
78       "roleName" : "ORG_BILLING_ADMIN"
79     } ]
80   } ],
81   "totalCount" : 2
82 }

戻る

プロジェクトのAPIキー

作成と割り当て

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}/apiKeys?pretty=true"

1	{
2	"links" : [ {
3	"href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"desc" : "Updated API Key description for DOCSP-6042",
8	"id" : "5d1cf1f980eef570c9fc87e5",
9	"links" : [ {
10	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11	"rel" : "self"
12	} ],
13	"privateKey" : "******--**-9d4ae38e4ddd",
14	"publicKey" : "{PUBLIC-KEY}",
15	"roles" : [ {
16	"groupId" : "{PROJECT-ID}",
17	"roleName" : "GROUP_AUTOMATION_ADMIN"
18	}, {
19	"groupId" : "{PROJECT-ID}",
20	"roleName" : "GROUP_MONITORING_ADMIN"
21	}, {
22	"orgId" : "5980cfe20b6d97029d82fa63",
23	"roleName" : "ORG_MEMBER"
24	}, {
25	"orgId" : "5980cfe20b6d97029d82fa63",
26	"roleName" : "ORG_BILLING_ADMIN"
27	}, {
28	"groupId" : "{PROJECT-ID}",
29	"roleName" : "GROUP_DATA_ACCESS_ADMIN"
30	}, {
31	"groupId" : "{PROJECT-ID}",
32	"roleName" : "GROUP_USER_ADMIN"
33	}, {
34	"groupId" : "{PROJECT-ID}",
35	"roleName" : "GROUP_READ_ONLY"
36	}, {
37	"groupId" : "{PROJECT-ID}",
38	"roleName" : "GROUP_OWNER"
39	}, {
40	"orgId" : "5980cfe20b6d97029d82fa63",
41	"roleName" : "ORG_OWNER"
42	}, {
43	"groupId" : "{PROJECT-ID}",
44	"roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
45	}, {
46	"orgId" : "5980cfe20b6d97029d82fa63",
47	"roleName" : "ORG_GROUP_CREATOR"
48	}, {
49	"orgId" : "5980cfe20b6d97029d82fa63",
50	"roleName" : "ORG_READ_ONLY"
51	}, {
52	"groupId" : "{PROJECT-ID}",
53	"roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54	}, {
55	"groupId" : "{PROJECT-ID}",
56	"roleName" : "GROUP_BACKUP_ADMIN"
57	}, {
58	"groupId" : "{PROJECT-ID}",
59	"roleName" : "GROUP_CLUSTER_MANAGER"
60	} ]
61	}, {
62	"desc" : "New API key for test purposes",
63	"id" : "5d1d12c087d9d63e6d682438",
64	"links" : [ {
65	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
66	"rel" : "self"
67	} ],
68	"privateKey" : "******--**-cb34f12aafdb",
69	"publicKey" : "oxhzytwb",
70	"roles" : [ {
71	"groupId" : "{PROJECT-ID}",
72	"roleName" : "GROUP_READ_ONLY"
73	}, {
74	"orgId" : "5980cfe20b6d97029d82fa63",
75	"roleName" : "ORG_MEMBER"
76	}, {
77	"orgId" : "5980cfe20b6d97029d82fa63",
78	"roleName" : "ORG_BILLING_ADMIN"
79	} ]
80	} ],
81	"totalCount" : 2
82	}

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

応答ドキュメント

results embeddedDocument

リクエストの例

注意

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ

`results` embeddedDocument