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

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ram:SetUserSsoSettings	update	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
MetadataDocument	string	否	元数据文档。经过 Base64 编码。由支持 SAML2.0 协议的身份提供商提供。	PD94bWwgdmVy****
SsoEnabled	boolean	否	是否开启 RAM 用户的 SSO 功能。取值： true：开启。 false（默认值）：关闭。	true
AuxiliaryDomain	string	否	辅助域名。	example.com
SsoLoginWithDomain	boolean	否	当用户使用 SAML SSO 登录时，是否要求 SAML Response 的`<saml:NameID>`元素内容中包含域名（即在 IdP 侧指定的用于 SSO 登录匹配的用户名是否带有域名后缀）。该参数取值为`true`时，`<saml:NameID>`元素内容必须形如`username@domain`（即带有域名后缀），其中`domain`可以是默认的域名，也可以是域别名（若已设置）。该参数取值为`false`时，`<saml:NameID>`元素内容应当仅有`username`部分（即不带有域名后缀），不得带有`domain`部分。该参数默认取值为`true`。	true

返回参数

名称	类型	描述	示例值
	object
UserSsoSettings	object	用户 SSO 配置信息。
AuxiliaryDomain	string	辅助域名。	example.com
MetadataDocument	string	元数据文档。经过 Base64 编码。	PD94bWwgdmVy****
SsoEnabled	boolean	是否开启用户 SSO。	true
SsoLoginWithDomain	boolean	当用户使用 SAML SSO 登录时，是否要求 SAML Response 的`<saml:NameID>`元素内容中包含域名（即在 IdP 侧指定的用于 SSO 登录匹配的用户名是否带有域名后缀）。该参数取值为`true`时，`<saml:NameID>`元素内容必须形如`username@domain`（即带有域名后缀），其中`domain`可以是默认的域名，也可以是域别名（若已设置）。该参数取值为`false`时，`<saml:NameID>`元素内容应当仅有`username`部分（即不带有域名后缀），不得带有`domain`部分。该参数默认取值为`true`。	true
RequestId	string	请求 ID。	87F2E3F6-28A0-43F3-A77F-F7760E62F61E

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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