对于AI助手:文档索引位于 https://www.mongodb.com/zh-cn/docs/llms.txt — 通过将 .md 附加到任何URL路径,可以获得所有页面的降价版本。
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs 菜单

Atlas API federatedAuthentication listIdentityProviders

返回指定联合中具有提供的协议和类型的所有身份提供程序。

atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。

如果未指定协议,则仅返回 SAML 身份提供程序。如果未指定 idpType,则仅返回 WORKFORCE 身份提供程序。要使用此资源,请求的服务帐户或 API 密钥必须在连接的组织之一中具有“组织所有者”角色。

此命令是自动生成的,对应 1:1 和Atlas API终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingidentityproviders

有关更多信息和示例,请参阅上面链接的参考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

响应每页返回的列项数。

-o, --output

字符串

false

首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。

--outputFile

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志

--pageNum

int

false

显示响应返回的当前总对象集的页面编号。

--protocol

字符串数组

false

目标身份提供程序的协议。

--version

字符串

false

调用Atlas 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 --federationSettingsId 55fa922fb343282757d9554e