更新 OIDC 身份提供商。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,提供对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈:https://反馈.mongodb.com/forum/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
语法
atlas federatedAuthentication federationSettings identityProvider update oidc [identityProviderId] [options] 
参数
| 名称 | 类型 | 必需 | 说明 | 
|---|---|---|---|
| identityProviderId | 字符串 | false | 身份提供商ID。 | 
选项
| 名称 | 类型 | 必需 | 说明 | 
|---|---|---|---|
| --associatedDomain | 字符串 | false | 与身份提供者关联的域列表。 | 
| --audience | 字符串 | false | 令牌预期接收者的标识符。 | 
| --authorizationType | 字符串 | false | 授权类型。 有效值为 GROUP 或 USER。 | 
| --clientId | 字符串 | false | 由身份提供程序分配给应用程序的客户端标识符。 | 
| --desc | 字符串 | false | 身份提供者的描述。 | 
| --federationSettingsId | 字符串 | true | 唯一的 24-十六进制数字string ,用于标识联合设置。 | 
| --groupsClaim | 字符串 | false | 令牌中包含 IdP 组 ID 的声明的标识符。 | 
| -h,--help | false | oidc 帮助 | |
| --idpType | 字符串 | true | 身份提供者的类型。 有效值为 WORKFORCE 或 WORKLOAD。 | 
| --issuerUri | 字符串 | false | string标识 OIDC 元数据/发现文档 发布者的唯一URL 。 | 
| -o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 | 
| --requestedScope | 字符串 | false | MongoDB 应用程序将从授权端点中请求的范围。 | 
| --userClaim | 字符串 | false | 令牌中包含用户 ID 的声明的标识符。 | 
继承选项
| 名称 | 类型 | 必需 | 说明 | 
|---|---|---|---|
| -P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 | 
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Identity provider '<Id>' updated. 
示例
# Update the audience of the identity provider with ID aa2223b25a115342acc1f108 and from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa with IdpType WORKFORCE atlas federatedAuthentication federationSettings identityProvider update aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKFORCE --audience newAudience