MongoDB Ops Manager 用の 1 つのグローバルAPIキーを作成します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /admin/apiKeys必須のロール
このエンドポイントとなる接続されたデバイスを呼び出すAPIキーがGlobal Ownerロールを持っている必要があります。
Request Parameters
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
すべてのリクエスト本文パラメータを指定する必要があります。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | グローバルAPIキーの説明。文字数は 1 文字から 250 文字の間である必要があります。 |
| string 配列 | 必須 | グローバル API キーが持つ必要があるロールのリスト。もし
デフォルトで受け入れられるグローバル ロールは次の通りです。
|
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | このグローバルAPIキーの説明。 |
| string | このグローバルAPIキーの一意の識別子。 |
| string | ドキュメントの配列は、1 つまたは複数のサブリソースまたは関連リソース ( リストのページネーション など) への リンク を表現します。詳細については、連携を参照してください。 |
| string | このグローバルAPIキーの編集されていない秘密キー。 |
| string | このグローバルAPIキーの公開キー。 |
| オブジェクト配列 | このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。 |
| string | ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。
|
リクエストの例
注意
リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true" \ --data '{ "desc" : "New API key for Global Testing", "roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_ADMIN" ] }'応答例
応答ヘッダー
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 Global Testing", "id" : "5d669ce780eef52a42cf0e1e", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", "rel" : "self" } ], "privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f", "publicKey" : "cfswjfck", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_USER_ADMIN" } ]}