首页 云SSO 开发参考 API参考 API目录 管理SCIM同步 SetSCIMSynchronizationStatus - 启用或禁用SCIM同步

SetSCIMSynchronizationStatus - 启用或禁用SCIM同步

更新时间: 2024-12-13 16:32:22

调用SetSCIMSynchronizationStatus启用或禁用SCIM同步。

接口说明

启用 SCIM 同步后,您才能从支持 SCIM 2.0 的外部 IdP 同步用户或用户组到云 SSO。禁用后,您将不能同步用户或用户组到云 SSO。启用或禁用 SCIM 同步的影响如下:

  • 在 SCIM 同步启用状态下,对于已同步到云 SSO 的 SCIM 用户和用户组,您不能修改和删除它们,也不能为 SCIM 用户组添加或移除用户,但可以修改用户的密码和状态。
  • 在 SCIM 同步禁用状态下,对于已同步到云 SSO 的 SCIM 用户和用户组,您可以修改或删除它们,也可以为 SCIM 用户组添加或移除用户。

本文将提供一个示例,启用目录d-00fc2p61****下的 SCIM 同步功能。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudsso:SetSCIMSynchronizationStatusupdate
*Directory
acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

请求参数

名称类型必填描述示例值
DirectoryIdstring

目录 ID。

d-00fc2p61****
SCIMSynchronizationStatusstring

SCIM 同步状态。取值:

  • Enabled:启用。
  • Disabled:禁用。
Enabled

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01

示例

正常返回示例

JSON格式

{
  "RequestId": "3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: DeleteSCIMServerCredential - 删除SCIM密钥 下一篇: GetSCIMSynchronizationStatus - 查询SCIM同步状态