パブリック プレビュー: でフィードバックを提供してください: 指定されたフェデレーション内の指定されたプロトコルとタイプを持つすべてのIDプロバイダーを返します。
プロトコルが指定されていない場合は、SAML ID プロバイダーのみが返されます。idpType が指定されていない場合は、WORKFORCE ID プロバイダーのみが返されます。このリソースを使用するには、リクエスト元の API キーが、接続されている組織のいずれかの組織オーナーロールを持っている必要があります。
1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Federated- に対応します認証/操作/listIdentityProviders。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api federatedAuthentication listIdentityProviders [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--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://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |
例
以下の コマンドを実行します。
atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1