调用SetExternalSAMLIdentityProvider配置SAML身份提供商（IdP）信息。
接口说明
在基于 SAML 2.0 的 SSO 登录过程中，云 SSO 目录是服务提供商（SP），而企业自有的身份管理系统则是身份提供商（IdP）。
配置 SAML 身份提供商（IdP）信息有以下两种方式，您可以任选其一进行配置，但不能同时进行配置。需要用到的元数据文档或相关参数，请从您的 IdP 中获取。
- 元数据文档：通过
EncodedMetadataDocument参数配置元数据文档。 - 手动配置：通过
EntityId、LoginUrl、WantRequestSigned和X509Certificate参数手动配置 IdP 信息。
如果已经配置过 SAML IdP 信息，则调用本 API 会替换已有的配置信息。具体如下：
- 元数据文档：全部替换为新的配置信息。
- 手动配置：只替换提供的新参数值。
说明
如果 SSO 登录状态是已启用，替换后的配置信息会立即生效，请注意对生产环境的影响。
本文将提供一个示例，在目录d-00fc2p61****下通过元数据文档配置 IdP 信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cloudsso:SetExternalSAMLIdentityProvider | update | *Directory acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DirectoryId | string | 是 | 目录 ID。 | d-00fc2p61**** |
| EncodedMetadataDocument | string | 否 | IdP 元数据文档（Base64 编码）。 由支持 SAML 2.0 协议的 IdP 提供。 | PD94bWwgdmVyc2lvbj0iMS4**** |
| SSOStatus | string | 否 | SSO 登录的启用状态。取值：
| Disabled |
| EntityId | string | 否 | IdP 标识。 | http://www.okta.com/exk3qwgtjhetR2Od**** |
| LoginUrl | string | 否 | IdP 的登录地址。 | https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml |
| WantRequestSigned | boolean | 否 | 在用户访问云 SSO 登录页面发起 SAML SSO 时，是否要求云 SSO 发送签名的 SAML 请求。取值：
| false |
| X509Certificate | string | 否 | PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。 | MIIC8DCCAdigAwIBAgIQP9eomUYGeoND**** |
| BindingType | string | 否 | 发起 SAML 请求的 Binding 方式。取值：
| Redirect |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "63160579-2E1B-57B0-8273-B27427172385",
"SAMLIdentityProviderConfiguration": {
"EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
"SSOStatus": "Disabled",
"DirectoryId": "d-00fc2p61****",
"EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
"CreateTime": "2021-11-10T02:57:16Z",
"WantRequestSigned": false,
"UpdateTime": "2021-11-10T02:57:16Z",
"CertificateIds": [
"[ \"idp-c-00buzdx63z8ewtdf****\", \"idp-c-00gmuxnr2mrek3t2****\" ]"
],
"LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
"BindingType": "Redirect"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-21 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |