すべての API キーを取得する

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

Resource

GET /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`フィールドを追加します。	なし

応答

応答ドキュメント

応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つの API キーです。

名前	タイプ	説明
`id`	string	API キーの一意の識別子
`desc`	string	API キーの説明
`privateKey`	string	API キーの編集済み秘密キー
`publicKey`	string	API キーの公開キー
`roles`	オブジェクト配列	API キーが持つロール
`roles.{ENTITY-ID}`	string	`{ENTITY-ID}`は、このロールが適用される組織またはプロジェクトを表します。可能な値は`orgId`または`groupId`です。
`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` プロジェクトロールグループとプロジェクトは同義語です。 `GROUP_OWNER` `GROUP_READ_ONLY` `GROUP_DATA_ACCESS_ADMIN` `GROUP_DATA_ACCESS_READ_WRITE` `GROUP_DATA_ACCESS_READ_ONLY` `GROUP_AUTOMATION_ADMIN` `GROUP_BACKUP_ADMIN` `GROUP_MONITORING_ADMIN` `GROUP_OWNER` `GROUP_USER_ADMIN`

リクエストの例

注意

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true"

応答例

応答ヘッダー

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}

レスポンス本体

{  "links" : [ {    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d97029d82e3f6/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",    "rel" : "self"  } ],  "results" : [ {    "desc" : "Test Docs Service User",    "id" : "5c47503320eef5699e1cce8d",    "links" : [ {      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d98829d82e3f6/apiKeys/5c47503ae0eef5699e1cce8d",      "rel" : "self"    } ],    "privateKey" : "********-****-****-db2c132ca78d",    "publicKey" : "ewmaqvdo",    "roles" : [ {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_OWNER"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_READ_ONLY"    }, {      "orgId" : "5980cfc70b6d97029d82e3f6",      "roleName" : "ORG_MEMBER"    } ]  } ],  "totalCount" : 1}