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

接続されたすべての IdP を返す

項目一覧

  • 必須のロール
  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • SAMLリクエストの例
  • SAML応答の例
  • OIDCリクエストの例
  • OIDC応答の例

federationSettingsリソースを使用すると、フェデレーション認証構成のすべてのID プロバイダーを返すことができます。

必須のロール

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

Resource

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

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

名前
タイプ
説明

FEDERATION-SETTINGS-ID

string

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

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

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

名前
タイプ
必要性
説明
default

pageNum

数値

任意

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

1

itemsPerPage

数値

任意

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

100

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

false

プロトコル

string

任意

ターゲットIdPのプロトコル。 可能な値は次のとおりです。

  • SAML

  • OIDC

これが指定されていない場合、このエンポイントはSAML IdPsのみを返します。

SAML

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

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

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明

results

配列

配列には、results 埋め込みドキュメント セクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。

links

配列

配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。

totalCount

数値

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

results embeddedDocument

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

名前
タイプ
説明

acsUrl

string

IdPが SAML 応答を送信するアサーション コンシューマー サービス URL。

associatedDomains

配列

ユーザーがこのIdPにログインできる構成済みのドメインを含むリスト。

associatedOrgs

配列

ユーザーがこのIdPにログインできる組織を含むリスト。

audienceUri

string

SAML アサーションの対象ユーザーの識別子。

displayName

string

IdPを識別する人間が判読できるラベル。

issuerUri

string

SAML アサーション の発行者の識別子。

oktaIdpId

string

IdP を識別する一意な 20 桁の 16 進数string 。

pemFileInfo

配列

IdP の PEM でエンコードされた公開キー証明書の開始日や有効期限などのファイル情報を含むリスト。

名前
タイプ
説明

証明書

配列

IdP のPEMでエンコードされた公開鍵証明書の開始日と有効期限が含まれたリスト。

fileName

string

IdP のPEMでエンコードされた公開鍵証明書を含むファイルを識別するラベル。

requestBinding

string

AuthNRequest を送信するために使用されるSAML認証要求プロトコル バインディング。 Cloud Manager は次のバインディング値をサポートしています。

  • HTTP POST

  • HTTP REDIRECT

responseSignatureAlgorithm

string

IdP署名を暗号化するために使用されるアルゴリズム。 Cloud Manager は次の署名アルゴリズム値をサポートしています。

  • SHA-1

  • SHA-256

ssoDebugEnabled

ブール値

IdPで SSO デバッグが有効になっているかどうかを示すフラグ。

ssoUrl

string

SAML AuthNRequest の受信者の URL。

status

string

IdP がアクティブかどうかを示すラベル。 少なくとも 1 つのドメインを IdP にマッピングするまで、 IdP はInactive です。

SAML リクエストの例

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/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders"

SAML 応答の例

{
 "links": [
     {
         "links" : [ {
 "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "acsUrl" : "https://example.mongodb.com/sso/saml2/12345678901234567890",
         "associatedDomains" : [ ],
         "associatedOrgs" : [ ],
         "audienceUri" : "https://www.example.com/saml2/service-provider/abcdefghij1234567890",
         "displayName" : "Test",
         "issuerUri" : "urn:123456789000.us.provider.com",
         "oktaIdpId" : "1234567890abcdefghij",
         "pemFileInfo" : {
             "certificates" : [ {
                "notAfter" : "2035-09-29T15:03:55Z",
                "notBefore" : "2022-01-20T15:03:55Z"
             } ],
             "fileName" : "file.pem"
         },
         "requestBinding" : "HTTP-POST",
         "responseSignatureAlgorithm" : "SHA-256",
         "ssoDebugEnabled" : true,
         "ssoUrl" : "https://123456789000.us.provider.com/samlp/12345678901234567890123456789012",
         "status" : "INACTIVE"
     } ],
 "totalCount": 1
}

OIDC リクエストの例

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/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?protocol=OIDC"

OIDC 応答の例

{
 "links": [
     {
         "links" : [ {
 "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "associatedDomains": [],
         "associatedOrgs": [],
         "audienceClaim": [
             "audience"
         ],
         "clientId": "clientId",
         "description": "OIDC IdP response example",
         "displayName": "OIDC IdP",
         "groupsClaim": "groups",
         "id": "32b6e34b3d91647abb20e7b8",
         "issuerUri": "issuer.com",
         "oktaIdpId": null,
         "protocol": "OIDC",
         "requestedScopes": [
             "scopes"
         ],
         "userClaim": "sub"
     }
 ],
 "totalCount": 1
}

戻る

ロール マッピングを返す

次へ

IdP を返す