federationSettings资源允许您返回联合身份验证配置的所有身份提供商。
所需角色
您必须在联合配置中具有至少一个已连接组织的Organization Owner角色，才能调用此端点。
Resource
GET /federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 唯一的 24 位十六进制数字字符串，用于标识联合身份验证配置。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 |
|
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 |
|
pretty | 布尔 | Optional |
| |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回结果列表的端点， |
|
protocol | 字符串 | Optional | 目标IdP的协议。 可能的值为：
如果未指定，此启用点仅返回 |
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应 JSON 文档包括 result 对象数组、link 对象数组和检索到的 result 对象的总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
results数组中的每个文档都包含每个已连接组织的联合身份验证配置。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | IdP将 SAML 响应发送到的断言消费者服务 URL。 |
| 阵列 | 包含已配置域的列表，用户可从这些域登录此IdP 。 |
| 阵列 | 包含用户可登录此IdP的组织的列表。 |
| 字符串 | SAML 断言目标受众的标识符。 |
| 字符串 | 用于标识IdP的人类可读标签。 |
| 字符串 | SAML 断言发布者的标识符 |
| 字符串 | 用于标识身份提供程序的唯一 20-十六进制数字字符串。 |
| 阵列 | 包含文件信息的列表，其中包括身份提供程序的PEM编码公钥证书的开始日期和到期日期。
|
| 字符串 | 用于发送 AuthNRequest 的SAML身份验证请求协议绑定。 Cloud Manager 支持以下绑定值：
|
| 字符串 | 用于加密IdP签名的算法。 Cloud Manager 支持以下签名算法值：
|
| 布尔 | 指示IdP是否已启用 SSO 调试的标志。 |
| 字符串 | SAML AuthnRequest 接收者的 URL。 |
| 字符串 | 标签，表示身份提供程序是否处于活动状态。身份提供程序 为 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 Response
{ "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}