実験的な : 指定されたフェデレーション内の 1 つのIdPを更新します。
このリソースを使用するには、リクエスト元のAPIキーが、接続されている組織のいずれかの組織オーナーロールを持っている必要があります。注:認可タイプを変更したり、認可要求を更新したりすると、現在のユーザーやグループがデータベースにアクセスできなくなる可能性があります。このコマンドは、OpsID: 'updateIdentityProvider' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/フェデレーティッド認証/ 操作/updateIdentityProvider
構文
atlas api federatedAuthentication updateIdentityProvider [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--federationSettingsId | string | true | フェデレーションを識別する一意の 24 桁の 16 進数文字列 |
--file | string | false | APIリクエストの内容を含むファイルへのパス |
-h, --help | false | updateIdentityProvider のヘルプ | |
--identityProviderId | string | true | 接続するIdPを識別する一意の文字列 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--version | string | false | API 呼び出しで使用する API バージョン [options: "2023-01-01", "2023-11-15"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2023-11-15" になります。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |