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

ベース URL: https://cloud.mongodb.com/api/public/v1.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` （組織）の場合、値には次のものが含まれます。 `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` （プロジェクト）の場合、値には次のものが含まれます。 `GROUP_AUTOMATION_ADMIN`: `Project Automation Admin` `GROUP_BACKUP_ADMIN`: `Project Backup 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}としてフォーマットできます。

1curl --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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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" : 282}

戻る

プロジェクトのAPIキー

作成と割り当て