API キーの作成

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

Resource

POST /orgs/{ORG-ID}/apiKeys

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

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

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

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

名前	タイプ	説明	default
pageNum	integer	ページ番号（1 インデックスベース）。	`1`
itemsPerPage	integer	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	レスポンス本体を pretty-print 形式にするかどうかを示します。	`false`
envelope	ブール値	応答をエンベロープでラップするかどうかを示します。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで `"envelope" : true` を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	なし

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

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

名前	タイプ	説明
`desc`	string	API キーの説明。長さが 1 文字から 250 文字の間である必要があります。
`roles`	string 配列	API キーが持つ必要があるロールのリスト。少なくとも 1 つのロールがリストされ、すべてのロールは組織に対して有効である必要があります。組織ロールには、以下が含まれます。 `ORG_OWNER`: `Organization Owner` `ORG_MEMBER`: `Organization Member` `ORG_GROUP_CREATOR`: `Organization Project Creator` `ORG_READ_ONLY`: `Organization 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またはMongoDB Ops Managerのいずれかでユーザーが持っているすべてのロールを返します。可能な値は次のとおりです。 `ORG_OWNER`: `Organization Owner` `ORG_MEMBER`: `Organization Member` `ORG_GROUP_CREATOR`: `Organization Project Creator` `ORG_READ_ONLY`: `Organization 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://<ops-manager-host>/api/public/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true" \  --data '{    "desc" : "New API key for test purposes",    "roles": ["ORG_MEMBER"]  }'

応答例

応答ヘッダー

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}

レスポンス本体

注意

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

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

戻る

1 つの取得

Update