公共预览版：请在以下位置提供反馈：返回指定联合中具有所提供协议和类型的所有身份提供程序。
如果未指定协议，则仅返回 SAML 身份提供商。如果未指定 idpType，则仅返回 WORKFORCE 身份提供程序。要使用该资源，请求的 API 密钥必须具有连接的组织之一的组织所有者角色。
此命令是自动生成的，对应于 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Federated-Authentication/operation/listIdentityProviders。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api federatedAuthentication listIdentityProviders [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--federationSettingsId | 字符串 | true | 用于标识联合的唯一的 24 位十六进制数字字符串。 |
-h，--help | false | listIdentityProviders 帮助 | |
--idpType | 字符串数组 | false | 目标身份提供程序的类型。 |
--itemsPerPage | int | false | 响应每页返回的列项数。 |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pageNum | int | false | 显示响应返回的当前总对象集的页面编号。 |
--protocol | 字符串数组 | false | 目标身份提供程序的协议。 |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-01-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
运行以下命令。
atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1