For the complete documentation index, see llms.txt. This page is also available as Markdown.

关于 SCIM

跨域身份管理系统 (SCIM) 用于在您的 Bitwarden 组织中自动配置成员和群组。Bitwarden 服务器提供了一个 SCIM 端点,该端点具有有效的 SCIM API 密钥,将接受来自您的身份提供程序 (IdP) 的用户和群组的配置和取消配置请求。

Bitwarden 支持使用标准属性映射的 SCIM v2,并提供以下集成文档:

本文仅讨论邀请用户和管理您的订阅席位数量的可用方法之一:

设置 SCIM

要设置 SCIM,您的 IdP 需要一个 SCIM URL 和 API 密钥,以便向 Bitwarden 服务器发出授权请求。这些值可以通过导航到 Admin Console 的设置 → SCIM 配置获取:

SCIM 配置
lightbulb

配置后邀请用户

默认情况下,通过 SCIM 配置的用户会被置于预配置状态,之后可以向其发出加入组织的邀请。您可以通过自动发送电子邮件邀请设置来更改此行为,该设置位于上述设置 → SCIM 配置界面中:

  • 开启时,用户一经配置便会自动收到电子邮件邀请。

  • 关闭时,用户会被置于预配置状态,而不会被立即邀请。预配置用户:

    • 不会收到邀请电子邮件。

    • 不占用许可证席位。

    • 不受组织策略约束。

必需属性

Bitwarden 使用此处列出的标准 SCIM v2 属性名称,但每个 IdP 也可以使用在配置期间映射到 Bitwarden 的备用名称。

用户属性

对于每个用户,Bitwarden 将使用以下属性:

  • 表明用户处于 active 状态的指示(必填)

  • email ª 或 userName(必填)

  • displayName

  • externalId

ª - 由于 SCIM 允许用户拥有多个电子邮箱地址(以对象数组形式表示),Bitwarden 将使用包含 "primary": true 的对象的 value。

群组属性

对于每个群组,Bitwarden 将使用以下属性:

  • displayName(必填)

  • members ª

  • externalId

ª - members 是一个对象数组,每个对象代表该群组中的一名用户。必须使用群组配置才能将已同步用户分配到群组,但是 SCIM API 无法用于查询群组中的成员。要查询群组成员资格,请使用公共 API。

SCIM 事件日志

用 SCIM 的组织会捕获 SCIM 集成所执行操作的事件日志,包括邀请用户和移除用户,以及创建或删除群组。SCIM 衍生的事件将在成员列中注册 SCIM。

现有对象更新

以下章节将说明当 IdP 发生变更时,SCIM 配置会将哪些更改同步到组织的成员和群组:

成员状态

当用户在您的 IdP 中被暂时挂起或停用(而非直接移除)时,其对您组织的访问权限将自动撤销。被撤销访问权限的用户将显示在组织成员界面的已撤销选项卡中,并且将:

成员电子邮箱地址

使用 SCIM 配置的成员可以在 Bitwarden 及其组织的相关 IdP 中更改电子邮箱地址。要更改 SCIM 组织中的 Bitwarden 电子邮箱地址,请执行以下操作:

  1. 通过导航到设置 → 我的账户在 Bitwarden 中更改电子邮箱地址(了解更多)。

  2. 在 Bitwarden 上更改电子邮箱地址后,更新 IdP 或 AD 客户端上的用户值。这可以是 externalid 或相应的值,取决于组织对 IdP 的选择。

  3. 重新同步 IdP 或 AD 客户端,以实现更改。

如果在更新 Bitwarden 电子邮箱之前,用户电子邮箱地址已在 IdP 或 AD 上更新并同步过,则更新后的电子邮箱将被视为新的用户。

如果您的组织使用受信任设备或 Key Connector,则谁可以更新成员的电子邮箱可能会有所不同:

  • 受信任设备:成员无法自行更改他们的电子邮箱,除非通过账户恢复获得了主密码。如果成员没有主密码且账户已声明,则管理员可以更改其电子邮箱。

  • Key Connector:成员无法自行更改他们的电子邮箱。

    • 如果您的组织未使用声明域名,请删除并使用新电子邮箱重新配置成员账户。提醒用户在删除账户之前导出数据,并在新账户设置完成后重新导入他们的数据。

    • 如果您的组织使用声明域名,则管理员可以直接更改成员的电子邮箱。

成员显示名称

虽然 SCIM API 请求可配置为包含成员显示名称,但该数据目前不会在初始配置时或 IdP 发生变更时同步至 Bitwarden。

成员外部 ID

虽然 SCIM 配置会在用户首次配置时为其分配一个外部 ID,但目前它不会将 IdP 中的外部 ID 更改同步至 Bitwarden。

SCIM 实施前的对象更新

以下章节说描述了 SCIM 配置将为组织中现有成员和群组同步的变更内容(针对 SCIM 实施前已存在的成员和群组):

SCIM 实施之前加入的成员

SCIM 配置将根据成员是否存在于 IdP 中,对 SCIM 实施之前加入您的组织的成员采取不同的处理方式:

  • 存在于 IdP 中且在 SCIM 实施前加入的成员不会被重复创建、无需重新加入组织,也不会从任何群组中移除。

  • 不存在于 IdP 中且在 SCIM 实施前加入的成员不会被移除,也不会被添加或移出任何群组。

SCIM 实施之前创建的群组

SCIM 配置将根据群组是否存在于 IdP 中,对 SCIM 实施前创建于您的组织的群组采取不同的处理方式:

  • 存在于 IdP 中且在 SCIM 实施前创建的群组不会被重复创建或移除任何成员,但会根据身份提供商分配的成员资格添加新成员。

  • 不存在于 IdP 中且在 SCIM 实施前创建的群组不会被移除,也不会添加或移除任何成员。

最后更新于