Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

1 つのグローバル API キーを作成

項目一覧

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

MongoDB Ops Manager 用の 1 つのグローバル APIキーを作成します。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /admin/apiKeys

このエンドポイントを呼び出すAPIキーに Global Ownerロールが必要です。

このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。

false

envelope

ブール値

任意

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

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

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

名前
説明

状態

HTTPレスポンス コード

envelope

期待される応答本体

false

すべてのリクエスト本文パラメータを指定する必要があります。

名前
タイプ
必要性
説明

desc

string

必須

グローバルAPIキーの説明。 長さが 1 文字から 250 文字の間である必要があります。

roles

string 配列

必須

グローバルAPIキーが持つ必要があるロールのリスト。 roles配列が提供されている場合:

  • 少なくとも 1 つのロールを指定する

  • すべてのロールが有効であることを確認します。

デフォルトで受け入れられるグローバル ロールは次の通りです。

API のロール値
ロール

GLOBAL_AUTOMATION_ADMIN

GLOBAL_BACKUP_ADMIN

GLOBAL_MONITORING_ADMIN

GLOBAL_OWNER

GLOBAL_READ_ONLY

GLOBAL_USER_ADMIN

名前
タイプ
説明

desc

string

このグローバルAPIキーの説明。

id

string

このグローバルAPIキーの一意の識別子。

links

string

1 つ以上のサブリソースや関連リソース( リストページ 分割 など)への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。

privateKey

string

このグローバルAPIキーの編集されていない秘密キー。

publicKey

string

このグローバルAPIキーの公開キー。

roles

オブジェクト配列

このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。

roles.roleName

string

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

API のロール値
ロール

GLOBAL_AUTOMATION_ADMIN

GLOBAL_BACKUP_ADMIN

GLOBAL_MONITORING_ADMIN

GLOBAL_OWNER

GLOBAL_READ_ONLY

GLOBAL_USER_ADMIN

注意

リクエストを行うユーザーは、 {USERNAME}:{APIKEY}または{PUBLIC-KEY}:{PRIVATE-KEY}として指定できます。

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true" \
6 --data '{
7 "desc" : "New API key for Global Testing",
8 "roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_ADMIN" ]
9 }'
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}
1{
2 "desc" : "New API key for Global Testing",
3 "id" : "5d669ce780eef52a42cf0e1e",
4 "links" : [ {
5 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
6 "rel" : "self"
7 } ],
8 "privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f",
9 "publicKey" : "cfswjfck",
10 "roles" : [ {
11 "roleName" : "GLOBAL_READ_ONLY"
12 }, {
13 "roleName" : "GLOBAL_USER_ADMIN"
14 } ]
15}

戻る

1 つの取得