Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API リソース
/
プログラム API キー
/
組織のプログラマティック API キー

API キーの作成

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

POST /orgs/{ORG-ID}/apiKeys

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

名前
タイプ
説明
ORG-ID
string
API キーを取得対象とする組織の一意の識別子。 認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgsエンドポイントを使用します。

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

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

名前
タイプ
説明
default
pageNum
integer
ページ番号（1 インデックス ベース）。
1
itemsPerPage
integer
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
false
envelope
ブール値

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

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

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

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

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

なし

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

すべての本体パラメータが必要です。

名前
タイプ
説明
desc
string
API キーの説明。 長さが 1 文字から 250 文字の間である必要があります。
roles
string 配列

API キーが持つ必要があるロールのリスト。 少なくとも 1 つのロールがリストされ、すべてのロールは組織に対して有効である必要があります。

組織ロールには、以下が含まれます。

API のロール値
ロール
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_BILLING_ADMIN
ORG_READ_ONLY

応答

名前
タイプ
説明
id
string
API キーの一意の識別子
desc
string
API キーの説明
privateKey
string
API キーの秘密キー。 このキーは、作成時にのみ編集されません。
publicKey
string
API キーの公開キー
roles
オブジェクト配列
API キーが持つロール
roles.orgId
string
orgIdは、このロールが適用される組織を表します。
roles.roleName
string

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

API のロール値
ロール
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_BILLING_ADMIN
ORG_READ_ONLY

リクエストの例

注意

リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true" \
     --data '{
       "desc" : "New API key for test purposes",
       "roles": ["ORG_MEMBER", "ORG_BILLING_ADMIN"]
     }'

応答例

応答ヘッダー

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}

レスポンス本体

注意

privateKeyはレスポンス本文に編集されていない状態で表示されます。 この例は、セキュリティ上の理由から編集されています。

{
  "desc" : "New API key for test purposes",
  "id" : "{API-KEY-ID}",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "{PUBLIC-KEY}",
  "roles" : [ {
    "orgId" : "{ORG-ID}",
    "roleName" : "ORG_BILLING_ADMIN"
  }, {
    "orgId" : "{ORG-ID}",
    "roleName" : "ORG_MEMBER"
  } ]
}

戻る

1 つの API キーを取得