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
GET /orgs/{ORG-ID}/federationSettings
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | 組織を識別する一意な 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| 文字列の配列 | 組織の IdP に関連付けられているドメインが格納されたリスト。 |
| ブール値 | この組織でロール マッピングが設定されているかどうかを示すフラグ。 ロール マッピングの詳細については、「 Cloud Manager ロールから IdP グループへのマッピングの管理 」を参照してください。 |
| string | このフェデレーションを識別する一意な 24 桁の 16 進数のstring 。 |
| string | この組織に接続されている IdP を識別する一意の 20 桁の 16 進数string 。 |
| string | IdP がアクティブかどうかを示す値。 Cloud Manager は、IdP がアクティブな場合は |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/federationSettings"
応答例
{ "federatedDomains": [ "example.com" ], "hasRoleMappings": false, "id": "5e8cc670a16506712e0b1e95", "identityProviderId": "0oa8i0grsgbwDiIyw453", "identityProviderStatus": "INACTIVE" }