SetExternalSAMLIdentityProvider_云SSO_API文档-阿里云OpenAPI开发者门户

接口说明

在基于 SAML 2.0 的 SSO 登录过程中，云 SSO 目录是服务提供商（SP），而企业自有的身份管理系统则是身份提供商（IdP）。

配置 SAML 身份提供商（IdP）信息有以下两种方式，您可以任选其一进行配置，但不能同时进行配置。需要用到的元数据文档或相关参数，请从您的 IdP 中获取。

元数据文档：通过EncodedMetadataDocument参数配置元数据文档。
手动配置：通过EntityId、LoginUrl、WantRequestSigned和X509Certificate参数手动配置 IdP 信息。

如果已经配置过 SAML IdP 信息，则调用本 API 会替换已有的配置信息。具体如下：

说明如果 SSO 登录状态是已启用，替换后的配置信息会立即生效，请注意对生产环境的影响。

本文将提供一个示例，在目录d-00fc2p61****下通过元数据文档配置 IdP 信息。

请求速率为10/1(s)。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

cloudsso:SetExternalSAMLIdentityProvider	Update	Directory acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}	无	无

字段名称	字段详情
DirectoryIdstring	目录 ID。示例值:d-00fc2p61****参考取值来源: UpdateDirectory CreateDirectory
EncodedMetadataDocumentstring	IdP 元数据文档（Base64 编码）。展开详情示例值:PD94bWwgdmVyc2lvbj0iMS4****
SSOStatusstring	SSO 登录的启用状态。取值：展开详情示例值:Disabled
EntityIdstring	IdP 标识。示例值:http://www.okta.com/exk3qwgtjhetR2Od****参考取值来源: GetExternalSAMLIdentityProvider
LoginUrlstring	IdP 的登录地址。示例值:https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
WantRequestSignedboolean	在用户访问云 SSO 登录页面发起 SAML SSO 时，是否要求云 SSO 发送签名的 SAML 请求。取值：展开详情示例值:false
X509Certificatestring	PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。示例值:MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****参考取值来源: AddExternalSAMLIdPCertificate ListExternalSAMLIdPCertificates
BindingTypestring	发起 SAML 请求的 Binding 方式。取值：展开详情示例值:Redirect

字段名称	字段详情
RequestIdstring	请求 ID。示例值:63160579-2E1B-57B0-8273-B27427172385
SAMLIdentityProviderConfigurationobject	IdP 配置信息。

	变更时间	变更内容概要	操作
	2024-08-21	新增请求参数BindingType 变更返回参数
	2021-06-21	新增OpenAPI，配置SAML身份提供商信息