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

1 つの接続された IdP を返す

項目一覧

  • 必須のロール
  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

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

必須のロール

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

Resource

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

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

名前
タイプ
説明
FEDERATION-SETTINGS-ID
string
フェデレーション認証構成を識別する一意な 24 桁の 16 進数のstring 。
IDP-ID
string
IdP を識別する一意な 20 桁の 16 進数string 。

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

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
false
envelope
ブール値
任意

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

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

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
status
HTTPレスポンス コード
content
期待される応答本体
false

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

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

応答

名前
タイプ
説明
acsUrl
string
IdPが SAML 応答を送信するアサーション コンシューマー サービス URL。
associatedDomains
配列
ユーザーがこのIdPにログインできる構成済みのドメインを含むリスト。
associatedOrgs
配列
ユーザーがこのIdPにログインできる組織を含むリスト。
audienceUri
string
displayName
string
IdPを識別する人間が判読できるラベル。
issuerUri
string
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 です。

リクエストの例

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/{IDP-ID}"

応答例

{
 "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"
 }

戻る

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

次へ

1 つの IdP のメタデータを返す