Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
フェデレーティッド認証

すべての接続された組織を返す

項目一覧

  • 必須のロール
  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • 結果 埋め込みドキュメント
  • リクエストの例
  • 応答例

federationSettingsリソースを使用すると、フェデレーション認証構成の接続されている組織をすべて返すことができます。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

必須のロール

このエンドポイントを呼び出すには、フェデレーション構成内の少なくとも 1 つの接続された組織のOrganization Ownerロールが必要です。

Resource

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/

リクエスト パス パラメーター

名前
タイプ
説明

FEDERATION-SETTINGS-ID

string

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

リクエスト クエリ パラメータ

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

名前
タイプ
必要性
説明
default

pageNum

数値

任意

結果のサブセクションを返す 1 から始まる整数。

1

itemsPerPage

数値

任意

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

false

backupJobsEnabledOnly

ブール値

任意

データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。

true

リクエスト ボディ パラメータ

このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。

応答

応答ドキュメント

応答JSONドキュメントには、結果オブジェクトの配列、リンクオブジェクトの配列、および検索された結果オブジェクトの合計数のカウントが含まれます。

名前
タイプ
説明

結果

オブジェクトの配列

結果の 埋め込みドキュメント セクションで詳細に説明されている各項目に対して 1 つのオブジェクト。

Links

オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

totalCount

integer

結果セット内の項目の合計数のカウント。 結果セット全体がページ分割される場合は、結果配列内のオブジェクトの数より大きくなる可能性があります。

結果 埋め込みドキュメント

result配列内の各ドキュメントには、接続されている組織ごとのフェデレーティッド認証構成が含まれています。

名前
タイプ
説明

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 GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

応答例

{
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}

戻る

構成を返す

次へ

組織を返す