実験的な : 指定されたフェデレーション内の指定されたプロトコルとタイプを持つすべてのIDプロバイダーを返します。
プロトコルが指定されていない場合は、SAML ID プロバイダーのみが返されます。idpType が指定されていない場合は、WORKFORCE ID プロバイダーのみが返されます。このリソースを使用するには、リクエスト元のAPIキーが、接続されている組織のいずれかの組織オーナーロールを持っている必要があります。このコマンドは、OpsID: 'listIdentityProviders' を使用してエンドポイントを呼び出しています。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/フェデレーティッド認証/ 操作/listIdentityProviders
構文
atlas api federatedAuthentication listIdentityProviders [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--federationSettingsId | string | true | フェデレーションを識別する一意の 24 桁の 16 進数文字列 |
-h, --help | false | listIdentityProviders のヘルプ | |
--idpType | stringArray | false | ターゲット IdP のタイプ |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりの項目の数 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pageNum | 整数 | false | レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号 |
--protocol | stringArray | false | ターゲット IdP のプロトコル |
--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 を参照してください。 |