AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つの接続済み組織を更新

federationSettingsリソースを使用すると、フェデレーション認証構成の接続された組織を 1 件更新できます。

ベース URL: https://cloud.mongodb.com/api/public/v1.0

このエンドポイントを呼び出すには、 Organization Ownerロールが必要です。

PATCH /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/
名前
タイプ
説明

FEDERATION-SETTINGS-ID

string

フェデレーション認証構成を識別する一意な 24 桁の 16 進数のstring 。

ORG-ID

string

接続済み組織を識別する一意な 24 桁の 16 進数のstring 。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

名前
タイプ
必要性
説明

domainAllowList

配列

任意

組織ユーザーがログインできる承認されたドメインを含むリスト。

リクエストでdomainAllowListフィールドを指定した場合、指定した配列が現在のdomainAllowListを置き換えます。

domainRestrictionEnabled

ブール値

必須

接続済み組織に対してドメイン制限が有効になっているかどうかを示すフラグ。

identityProviderId

string

必須

接続済み組織に関連付けられている IdP を識別する一意の 20 桁の 16 進数string 。

省略した場合、または値がnullの場合、MongoDB Cloud はorgIdで指定された組織をIdPから切断します。

orgId

string

必須

接続済み組織を識別する一意な 24 桁の 16 進数のstring 。

postAuthRoleGrants

配列

任意

接続済み組織内の IdP 経由で認証するユーザーに付与されるデフォルトの ロール を格納したリスト。

リクエストでpostAuthRoleGrantsフィールドを指定した場合、指定した配列が現在のpostAuthRoleGrantsを置き換えます。

roleMappings

配列

任意

この組織で設定されているロール マッピングが格納されたリスト。

リクエストでroleMappingsフィールドを指定した場合、指定した配列が現在のroleMappingsを置き換えます。

名前
タイプ
説明

domainAllowList

配列

組織ユーザーがログインできる承認されたドメインを含むリスト。

domainRestrictionEnabled

ブール値

接続済み組織に対してドメイン制限が有効になっているかどうかを示すフラグ。

userConflicts nullは、 の場合に"domainRestrictionEnabled": false を返します。

identityProviderId

string

接続済み組織に関連付けられている IdP を識別する一意の 20 桁の 16 進数string 。

orgId

string

接続済み組織を識別する一意な 24 桁の 16 進数のstring 。

postAuthRoleGrants

配列

接続済み組織内の IdP 経由で認証するユーザーに付与されるデフォルトの ロール を格納したリスト。

roleMappings

配列

この組織で設定されているロール マッピングが格納されたリスト。

userConflicts

配列

許可リストのどのドメインとも一致しないユーザー名を含むリスト。

userConflicts nullは、 の場合に"domainRestrictionEnabled": false を返します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}" \ --data ' { "domainRestrictionEnabled": false, "identityProviderId": "0oa7i0grsgbwJiIyw357", "orgId": "5df7a168f10fab3a149357fb", "roleMappings": [ { "externalGroupName": "example", "id": "61e89721b827b56c845ff44c", "roleAssignments": [ { "groupId": null, "orgId": "5df7a168f10fab3a149357fb", "role": "ORG_OWNER" } ] } ] }'
{ "domainAllowList": [], "domainRestrictionEnabled": false, "identityProviderId": "0oa7i0grsgbwJiIyw357", "orgId": "5df7a168f10fab3a149357fb", "postAuthRoleGrants": [ "ORG_OWNER" ], "roleMappings": [ { "externalGroupName": "example", "id": "61e89721b827b56c845ff44c", "roleAssignments": [ { "groupId": null, "orgId": "5df7a168f10fab3a149357fb", "role": "ORG_OWNER" } ] } ], "userConflicts": null}