文档

SetUserSsoSettings - 设置用户SSO身份提供商信息

更新时间:

设置用户SSO的身份提供商信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ram:SetUserSsoSettingsupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
MetadataDocumentstring

元数据文档。经过 Base64 编码。

由支持 SAML2.0 协议的身份提供商提供。

PD94bWwgdmVy****
SsoEnabledboolean

是否开启 RAM 用户的 SSO 功能。取值:

  • true:开启。
  • false(默认值):关闭。
true
AuxiliaryDomainstring

辅助域名。

example.com

返回参数

名称类型描述示例值
object
UserSsoSettingsobject

用户 SSO 配置信息。

AuxiliaryDomainstring

辅助域名。

example.com
MetadataDocumentstring

元数据文档。经过 Base64 编码。

PD94bWwgdmVy****
SsoEnabledboolean

是否开启用户 SSO。

true
RequestIdstring

请求 ID。

87F2E3F6-28A0-43F3-A77F-F7760E62F61E

示例

正常返回示例

JSON格式

{
  "UserSsoSettings": {
    "AuxiliaryDomain": "example.com",
    "MetadataDocument": "PD94bWwgdmVy****",
    "SsoEnabled": true
  },
  "RequestId": "87F2E3F6-28A0-43F3-A77F-F7760E62F61E"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-14OpenAPI 描述信息更新查看变更详情