mongocli IAM organizations apiKeys describe
組織の指定された API キーの詳細を返します。
ID 引数の可能な値を表示するには、 mongocli IAM 組織 apiKeys list を実行します。
このコマンドを使用するには、ユーザー アカウントまたは組織メンバー ロールを持つ API キーで認証する必要があります。
構文
コマンド構文
mongocli iam organizations apiKeys describe <ID> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
ID | string | true | キーを識別する一意な 24stringAPI 桁の 。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | 説明用のヘルプ | |
--orgId | string | false | 使用する組織ID。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 MongoCLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-configuration-file を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
ID DESCRIPTION PUBLIC KEY PRIVATE KEY <ID> <Desc> <PublicKey> <PrivateKey>
例
# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli iam organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json