Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

Atlas API federatedAuthentication getFederationSettings

实验:返回有关指定组织的联合设置的信息。

要使用此资源,请求的API密钥必须在连接的组织中具有组织所有者角色。此命令正在调用 OperationID 为“getFederationSettings”的端点。有关标志、文件格式和示例的更多信息,请参阅:https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Federated-Authentication/operation/getFederationSettings

命令语法
atlas api federatedAuthentication getFederationSettings [options]
名称
类型
必需
说明

--envelope

false

标志,指示应用程序是否将响应包装在信封JSON对象中

-h,--help

false

getFederationSettings 帮助

--orgId

字符串

true

唯一的 24-十六进制数字字符串,用于标识包含项目的组织

--output

字符串

false

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

--output-file

字符串

false

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

--pretty

false

标志,指示响应正文是否应采用美观打印格式

--version

字符串

false

进行API调用时要使用的API版本 [选项:"2023-01-01"],默认为最新版本或配置文件 api_version 配置值(如果设立了此值),默认为 "2023-01-01"。

名称
类型
必需
说明

-P, --profile

字符串

false

后退

getConnectedOrgConfig

在此页面上