ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | APIキーを更新するプロジェクトの一意の識別子です。 認証済みユーザーがアクセスできるすべての組織を取得するには、 /groupsエンドポイントを使用します。 |
| string | 更新対象の API キーの一意の識別子。指定された組織の、認証済みユーザーがアクセスできるすべての API キーを検索するには、 /groups/{PROJECT-ID}/apiKeys エンドポイントとなる接続されたデバイスをリクエストします。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | レスポンスをエンベロープにラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
body パラメーターは必須です。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string 配列 | 必須 | API キーに付与する必要があるロールのリスト最少1つのロールを提供する必要があります。提供されるロールはすべて、割り当てられたプロジェクトに対して有効である必要があります。
この API キーが持つすべてのロールを含めます。 この配列にないロールは削除されます。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | このプロジェクトに割り当てられた組織APIキーの説明。 |
| string | このプロジェクトに割り当てられた組織APIキーの一意の識別子。 |
| string | このプロジェクトに割り当てられた組織APIキーの編集済み秘密キー。 このキーは、最初に作成したときは編集されずに表示されます。 |
| string | このプロジェクトに割り当てられた組織APIキーの公開キー。 |
| オブジェクト配列 | このプロジェクトに割り当てられたこの組織APIキーが持つロール。 この配列は、Cloud Manager でユーザーが持っているすべての組織ロールとプロジェクト ロールを返します。 |
| string | このロールが属するプロジェクトの一意の識別子。 |
| string | このロールが属する組織の一意の識別子。 |
| string | ロールの名前。 このリソースは、Cloud Managerでユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。 組織ロール これが
プロジェクト ロール これが
|
リクエストの例
注意
リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d143c87d9d63e6d694746?pretty=true" \ --data '{ "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ] }'応答例
応答ヘッダー
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-aliveHTTP/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}レスポンス本体
{ "desc" : "New API key for test purposes", "id" : "5d1d143c87d9d63e6d694746", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746", "rel" : "self" } ], "privateKey" : "********-****-****-eac4256753ba", "publicKey" : "{PUBLIC-KEY}", "roles" : [ { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_BILLING_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_MEMBER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" } ]}