SAML 集成

第三方集成中的 SAML 集成,可以通过集成 SAML(2.0 标准协议)连接企业 SAML 身份验证服务,实现单点登录。

适用版本

专属版

创建范围外用户

站点管理员可以在站点管理 > 第三方集成中配置和管理 SAML 集成。如需创建不在 SAML 中的用户,可以勾选支持内建用户,可以创建同步范围外的用户

image

配置 SAML

步骤一 配置 SAML 连接

为了建立云效 SP(Service Provider,服务提供方)对企业 IdP(Identity Provider,SAML身份源)的连接,需要配置以下信息:

  • SAML 元数据文档地址:企业 IdP 元数据地址。

  • 公钥:云效 SP 的自签名证书,public.crt的文件内容。

  • 私钥:云效 SP 私钥,rsa_private.key的文件内容。

私钥和云效自签名证书的生成命令如下:

openssl req -newkey rsa:2048 -nodes -keyout rsa_private.key -x509 -days 3650 -out public.crt

image

填写完成后,单击下一步

步骤二 配置元数据

为了建立企业 IdP 对云效的信任,需要在企业 IdP 中配置云效为可信 SAML SP 并进行 SAML 断言属性的配置。在企业 IdP 中创建一个 SAML SP,并根据实际情况选项下面任意一种方式配置云效为信赖方:

  • 直接复制下方云效作为 SAML SP 的SAML 服务提供方元数据的 URL 地址,配置到 SAML 服务中。

  • 如果企业使用的 IdP 不支持 URL 配置,可以下载SAML 服务提供方元数据文件并上传到 IdP。

  • 如果企业使用的 IdP 不支持元数据文件上传,则需要手动配置以下参数:

    • Entity ID:下载的SAML 服务提供方元数据文件中,md:EntityDescriptor 元素的 entityID 属性值。

    • ACS URL:下载的SAML 服务提供方元数据文件中,md:AssertionConsumerService 元素的 Location 属性值。

    • SLO URL:下载的SAML 服务提供方元数据文件中,SingleLogoutService 的 Location 属性值。

image

配置和填写完成后,单击下一步。

步骤三 配置账号绑定与属性映射

目前提供种 4 种账号识别和绑定方式:

  • 自动绑定邮箱相同的账号:按照同步策略,自动将云效、SAML 中邮箱账号相同的用户绑定在一起。

  • 自动绑定登录账号相同的账号:按照同步策略,自动将云效、SAML 中登录账号相同的用户绑定在一起。

  • 自动绑定手机号相同的账号:按照同步策略,自动将云效、SAML 中手机号相同的用户绑定在一起。

  • 自动绑定工号相同的账号:按照同步策略,自动将云效、SAML 中工号相同的用户绑定在一起。

无论选择哪一种账号识别和绑定方式,均需要保证其对应的属性字段的唯一性和存在性,因为云效将按照选择的方式进行账号的一一匹配,如下图为选择自动绑定邮箱相同的账号的绑定过程:

image

接下来需配置用户属性映射的字段,云效将按照下图中设置的用户属性字段映射关系进行信息映射。

image

填写完成后,单击下一步

步骤四 开启单点登录服务

在配置过程中,单点登录的功能默认不开启,开启后,可进行 SAML 单点登录相关配置:

  • 修改 SAML 显示名称和显示图标,修改后云效系统上将按照修改的内容显示 SAML 的信息。

  • 开启单点登出(SLO):默认不开启单点登出,勾选后需要将云效的单点登出地址配置在 SAML Idp 中方可完成 SLO 配置,完成后将可以保持云效与 SAML Idp 的登出状态同步。

  • 允许开启首次登录时创建云效账号:

    • 默认不勾选:登录时仅允许 SAML 账号与云效账号进行绑定,匹配不到云效账号时,云效不会根据 SAML 账号创建云效账号。

    • 勾选后:允许在 SAML 账号登录云效且 SAML 账号无法匹配到云效账号时,云效创建新的云效账号与之绑定。

image

如果选择不开启单点登录,也可保存配置,后续可以在 SAML 集成详情页面中开启服务。

image

当完成所有配置后,单击保存配置按钮即可完成 SAML 集成的配置。

通过 SAML 登录云效

开启单点登录后,云效登录页面将显示 SAML 登录入口,点击后可进入 SAML 账号登录页面,已绑定 SAML 账号的用户可以通过 SAML 账号登录。

退出登录

用户在云效退出登录,会同时退出 SAML IdP 的登录态。如需实现 SAML IdP 退出登录时退出云效,可参考配置步骤中第四步进行 SLO 配置。

会话持续时间和时长

会话持续时间以云效设置的为准,若超过云效设置的登录保持时间,会退出云效,如需继续使用云效需要重新登录。

修改 SAML 配置

在 SAML 集成详情页中,可以看到查看/修改配置入口,单击后即可在抽屉中修改非必填的用户属性映射信息,其他配置信息不允许修改。

关闭单点登录服务

在 SAML 集成详情页中,已经开启单点登录的情况下,可单击修改服务配置,在打开的修改配置的抽屉中可以关闭单点登录服务,关闭单点登录后:

  • 不会解除云效账号与 SAML 账号的绑定关系。

  • 不支持通过 SAML 账号登录云效,用户若需要登录云效,可使用云效的登录账号和密码进行登录。

移除 SAML 集成

在 SAML 集成详情页中,可单击移除集成按钮,二次确认后即可移除 SAML 集成,移除集成后:

  • 解除云效账号和 SAML 账号的绑定关系。

  • 不支持通过 SAML 登录云效,用户若需要登录云效,可使用云效的登录账号和密码进行登录。

image