1 つの接続済み組織を更新
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
federationSettingsリソースを使用すると、フェデレーション認証構成の接続された組織を 1 件更新できます。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
必須のロール
このエンドポイントを呼び出すには、 Organization Ownerロールが必要です。
Resource
PATCH /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | フェデレーション認証構成を識別する一意な 24 桁の 16 進数のstring 。 |
| string | 接続済み組織を識別する一意な 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| 配列 | 任意 | 組織ユーザーがログインできる承認されたドメインを含むリスト。 リクエストで |
| ブール値 | 必須 | 接続済み組織に対してドメイン制限が有効になっているかどうかを示すフラグ。 |
| string | 必須 | 接続済み組織に関連付けられている IdP を識別する一意の 20 桁の 16 進数string 。 省略した場合、または値が |
| string | 必須 | 接続済み組織を識別する一意な 24 桁の 16 進数のstring 。 |
| 配列 | 任意 | 接続済み組織内の IdP 経由で認証するユーザーに付与されるデフォルトの ロール を格納したリスト。 リクエストで |
| 配列 | 任意 | この組織で設定されているロール マッピングが格納されたリスト。 リクエストで |
応答
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 組織ユーザーがログインできる承認されたドメインを含むリスト。 |
| ブール値 | 接続済み組織に対してドメイン制限が有効になっているかどうかを示すフラグ。
|
| string | 接続済み組織に関連付けられている IdP を識別する一意の 20 桁の 16 進数string 。 |
| string | 接続済み組織を識別する一意な 24 桁の 16 進数のstring 。 |
| 配列 | 接続済み組織内の IdP 経由で認証するユーザーに付与されるデフォルトの ロール を格納したリスト。 |
| 配列 | この組織で設定されているロール マッピングが格納されたリスト。 |
| 配列 | 許可リストのどのドメインとも一致しないユーザー名を含むリスト。
|
リクエストの例
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 }