すべての API キーを取得する
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /orgs/{ORG-ID}/apiKeys
リクエスト パス パラメーター
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 | 1 | ||||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||||
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 | false | ||||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
results | 配列 | 配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つの API キーです。
名前 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | API キーの一意の識別子 | ||||||||||||
desc | string | API キーの説明 | ||||||||||||
privateKey | string | API キーの編集済み秘密キー | ||||||||||||
publicKey | string | API キーの公開キー | ||||||||||||
roles | オブジェクト配列 | API キーが持つロール | ||||||||||||
roles.{ENTITY-ID} | string | {ENTITY-ID}は、このロールが適用される組織またはプロジェクトを表します。 可能な値はorgIdまたはgroupIdです。 | ||||||||||||
roles.roleName | string | ロールの名前。
|
リクエストの例
注意
リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true"
応答例
応答ヘッダー
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
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}
レスポンス本体
{ "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d97029d82e3f6/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "desc" : "Test Docs Service User", "id" : "5c47503320eef5699e1cce8d", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98829d82e3f6/apiKeys/5c47503ae0eef5699e1cce8d", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "ewmaqvdo", "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" } ] } ], "totalCount" : 1 }