实验:返回指定联合中具有所提供协议和类型的所有身份提供程序。
如果未指定协议,则仅返回 SAML 身份提供商。如果未指定 idpType,则仅返回 WORKFORCE 身份提供程序。要使用此资源,请求的API密钥必须在连接的组织之一中具有组织所有者角色。此命令正在调用 OperationID 为“listIdentityProviders”的端点。有关标志、文件格式和示例的更多信息,请参阅:https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Federated-Authentication/operation/listIdentityProviders
语法
atlas api federatedAuthentication listIdentityProviders [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--envelope | false | 标志,指示应用程序是否将响应包装在信封JSON对象中 | |
--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。 |