federationSettingsリソースを使用すると、フェデレーション認証構成のに接続された組織を 1 つ返すことができます。
ベース URL: https://cloud.mongodb.com/api/public/v1.0
必須のロール
このエンドポイントを呼び出すには、 Organization Ownerロールが必要です。
Resource
GET /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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 組織ユーザーがログインできる承認されたドメインを含むリスト。 |
| ブール値 | 接続済み組織に対してドメイン制限が有効になっているかどうかを示すフラグ。
|
| 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 GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}"
応答例
{ "domainAllowList": [], "domainRestrictionEnabled": false, "identityProviderId": null, "orgId": "5f86fb11e0079069c9ec3132", "postAuthRoleGrants": [], "roleMappings": [], "userConflicts": null }