Docs Menu

Atlas API ldapConfiguration getLdapConfigurationStatus

実験的な : 指定されたプロジェクトの 1 つの LDAP 設定を確認する 1 つのリクエストのステータスを返します。

このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/LDAP- に対応しますConfiguration/操作/getLdapConfigurationStatus

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api ldapConfiguration getLdapConfigurationStatus [options]
名前
タイプ
必須
説明

-- envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数の文字列

-h, --help

false

getLdapConfigurationStatus のヘルプ

--出力

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- output-file

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--pretty

false

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

--requestId

string

true

LDAP 設定を検証するためのリクエストを識別する一意な文字列

--version

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。