API概览 - 云SSO

API标准及多语言预置SDK

本产品（cloudsso/2021-05-15）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

管理云SSO

API	标题	API概述
EnableService	开通云SSO	调用EnableService开通云SSO。
DisableService	关闭云SSO	调用DisableService关闭云SSO。
GetServiceStatus	查询云SSO状态	调用GetServiceStatus查询云SSO状态。
CreateDirectory	创建目录	调用CreateDirectory创建目录。
ListDirectories	查询目录列表	调用ListDirectories查询目录列表。
GetDirectory	查询目录信息	调用GetDirectory查询目录信息。
GetDirectoryStatistics	查询目录的统计信息	调用GetDirectoryStatistics查询目录的统计信息。
UpdateDirectory	修改目录名称	调用UpdateDirectory修改目录名称。
DeleteDirectory	删除目录	调用DeleteDirectory删除目录。
EnableDelegateAccount	启用云SSO委派管理员账号	调用EnableDelegateAccount启用云SSO委派管理员账号。
DisableDelegateAccount	禁用云SSO委派管理员账号	调用DisableDelegateAccount禁用云SSO委派管理员账号。

管理用户

API	标题	API概述
CreateUser	创建用户	调用CreateUser创建用户。
ListUsers	查询用户列表	调用ListUsers查询用户列表。
GetUser	查询用户信息	调用GetUser查询指定用户信息。
UpdateUser	修改用户信息	调用UpdateUser修改用户信息。
UpdateUserStatus	修改用户状态	调用UpdateUserStatus修改用户状态。
DeleteUser	删除用户	调用DeleteUser删除用户。
ResetUserPassword	重置用户密码	调用ResetUserPassword重置用户密码。
ListMFADevicesForUser	查询用户的MFA设备列表	调用ListMFADevicesForUser查询用户的MFA设备列表。每个用户最多只能有2个MFA设备。
DeleteMFADeviceForUser	删除用户的MFA设备	调用DeleteMFADeviceForUser删除用户的MFA设备。
UpdateMFAAuthenticationSettings	修改全局MFA配置	调用UpdateMFAAuthenticationSettings修改全局MFA配置。
GetMFAAuthenticationSettings	查询全局MFA配置	调用GetMFAAuthenticationSettings查询全局MFA配置。
UpdateUserMFAAuthenticationSettings	修改用户MFA独立配置	调用UpdateUserMFAAuthenticationSettings修改用户MFA独立配置。
GetUserMFAAuthenticationSettings	查询用户MFA独立配置	调用GetUserMFAAuthenticationSettings查询用户MFA独立配置。
GetMFAAuthenticationSettingInfo	查询全局MFA配置	调用GetMFAAuthenticationSettingInfo查询全局MFA配置。
SetLoginPreference	设置登录偏好	调用SetLoginPreference设置云SSO用户的登录偏好。
GetLoginPreference	查询登录偏好	调用GetLoginPreference查询登录偏好。
SetPasswordPolicy	设置密码策略	调用SetPasswordPolicy设置云SSO用户的密码策略。
GetPasswordPolicy	查询密码策略	调用GetPasswordPolicy查询云SSO用户的密码策略。
GetUserId	通过ExternalId获取用户ID	调用GetUserId通过ExternalId获取目录下对应的用户ID。

管理用户组

API	标题	API概述
CreateGroup	创建用户组	调用CreateGroup创建用户组。
ListGroups	查询用户组列表	调用ListGroups查询用户组列表。
GetGroup	查询用户组信息	调用GetGroup查询指定用户组信息。
UpdateGroup	修改用户组信息	调用UpdateGroup修改用户组信息。
DeleteGroup	删除用户组	调用DeleteGroup删除指定用户组。
AddUserToGroup	为用户组添加用户	调用AddUserToGroup为用户组添加用户。
RemoveUserFromGroup	从用户组中移除用户	从用户组中移除用户。
ListJoinedGroupsForUser	查询用户加入的用户组	查询用户加入的用户组。
ListGroupMembers	查询用户组中的用户列表	查询用户组中的用户列表。

管理SCIM同步

API	标题	API概述
CreateSCIMServerCredential	创建SCIM密钥	调用CreateSCIMServerCredential创建SCIM密钥。
ListSCIMServerCredentials	查询SCIM密钥列表	调用ListSCIMServerCredentials查询SCIM密钥列表。
UpdateSCIMServerCredentialStatus	启用或禁用SCIM密钥	调用UpdateSCIMServerCredentialStatus启用或禁用SCIM密钥。
DeleteSCIMServerCredential	删除SCIM密钥	调用DeleteSCIMServerCredential删除SCIM密钥。
SetSCIMSynchronizationStatus	启用或禁用SCIM同步	调用SetSCIMSynchronizationStatus启用或禁用SCIM同步。
GetSCIMSynchronizationStatus	查询SCIM同步状态	调用GetSCIMSynchronizationStatus查询SCIM同步的状态。

管理单点登录

API	标题	API概述
GetDirectorySAMLServiceProviderInfo	查询SAML服务提供商信息	调用GetDirectorySAMLServiceProviderInfo查询SAML服务提供商（SP）信息。
SetExternalSAMLIdentityProvider	配置SAML身份提供商信息	调用SetExternalSAMLIdentityProvider配置SAML身份提供商（IdP）信息。
GetExternalSAMLIdentityProvider	查询SAML身份提供商配置信息	调用GetExternalSAMLIdentityProvider查询SAML身份提供商（IdP）的配置信息。
ClearExternalSAMLIdentityProvider	清空SAML身份提供商配置信息	调用ClearExternalSAMLIdentityProvider清空SAML身份提供商（IdP）的配置信息。
AddExternalSAMLIdPCertificate	添加SAML签名证书	调用AddExternalSAMLIdPCertificate添加SAML签名证书。
ListExternalSAMLIdPCertificates	查询SAML签名证书列表	调用ListExternalSAMLIdPCertificates查询SAML签名证书列表。
RemoveExternalSAMLIdPCertificate	移除SAML签名证书	调用RemoveExternalSAMLIdPCertificate移除SAML签名证书。

管理访问配置

API	标题	API概述
CreateAccessConfiguration	创建访问配置	创建访问配置。
ListAccessConfigurations	查询访问配置列表	调用ListAccessConfigurations查询访问配置列表。
GetAccessConfiguration	查询访问配置信息	调用GetAccessConfiguration查询访问配置信息。
UpdateAccessConfiguration	修改访问配置信息	调用UpdateAccessConfiguration修改访问配置信息。
DeleteAccessConfiguration	删除访问配置	调用DeleteAccessConfiguration删除访问配置。
AddPermissionPolicyToAccessConfiguration	为访问配置添加权限策略	为访问配置添加权限策略。
RemovePermissionPolicyFromAccessConfiguration	为访问配置移除权限策略	为访问配置移除权限策略。
UpdateInlinePolicyForAccessConfiguration	修改访问配置的内置策略	调用UpdateInlinePolicyForAccessConfiguration修改访问配置的内置策略。
ListPermissionPoliciesInAccessConfiguration	查询访问配置中的权限策略列表	查询访问配置中的权限策略列表。

管理多账号授权

API	标题	API概述
ProvisionAccessConfiguration	将访问配置部署到RD账号上	调用ProvisionAccessConfiguration将访问配置部署到RD账号上。
DeprovisionAccessConfiguration	解除访问配置在RD账号上的部署	调用DeprovisionAccessConfiguration解除访问配置在RD账号上的部署。
ListAccessConfigurationProvisionings	查询访问配置部署列表	调用ListAccessConfigurationProvisionings查询访问配置部署列表。
CreateAccessAssignment	在RD账号上授权	为RD账号设置允许访问的用户或用户组，以及对应的访问权限（访问配置）。
ListAccessAssignments	查询授权列表	调用ListAccessAssignments查询授权列表。
DeleteAccessAssignment	移除RD账号上的授权	调用DeleteAccessAssignment移除RD账号上的授权。
ListTasks	查询异步任务列表	调用ListTasks查询异步任务列表。
GetTask	查询异步任务信息	调用GetTask查询异步任务信息。
GetTaskStatus	查询异步任务的状态	调用GetTaskStatus查询异步任务的状态。

管理RAM用户同步

API	标题	API概述
CreateUserProvisioning	创建RAM用户同步	调用CreateUserProvisioning创建RAM用户同步。
GetUserProvisioning	查询RAM用户同步	调用GetUserProvisioning查询RAM用户同步信息。
ListUserProvisionings	查询RAM用户同步列表	调用ListUserProvisionings查询RAM用户同步列表。
UpdateUserProvisioning	修改RAM用户同步	调用UpdateUserProvisioning修改RAM用户同步。
DeleteUserProvisioning	删除RAM用户同步	调用DeleteUserProvisioning删除RAM用户同步。
UpdateUserProvisioningConfiguration	修改RAM用户同步全局配置	调用UpdateUserProvisioningConfiguration修改RAM用户同步全局配置。
GetUserProvisioningConfiguration	查询RAM用户同步全局配置	调用GetUserProvisioningConfiguration查询RAM用户同步全局配置。
ListUserProvisioningEvents	查询RAM用户同步事件列表	调用ListUserProvisioningEvents查询执行失败的RAM用户同步事件列表。
GetUserProvisioningEvent	查询RAM用户同步事件	调用GetUserProvisioningEvent查询执行失败的RAM用户同步事件。
DeleteUserProvisioningEvent	删除RAM用户同步事件	调用DeleteUserProvisioningEvent删除执行失败的RAM用户同步事件。
RetryUserProvisioningEvent	重试RAM用户同步事件	调用RetryUserProvisioningEvent重试执行失败的RAM用户同步事件。
GetUserProvisioningStatistics	查询RAM用户同步的统计信息	调用GetUserProvisioningStatistics查询RAM用户同步的统计信息。
GetUserProvisioningRdAccountStatistics	查询资源目录成员的RAM用户同步统计信息	调用GetUserProvisioningRdAccountStatistics查询资源目录成员账号中的RAM用户同步任务统计信息。

其他（不维护）

API	标题	API概述
SetMFAAuthenticationStatus	为目录中的用户启用或禁用MFA	调用SetMFAAuthenticationStatus为目录中的用户启用或禁用多因素认证（MFA）。
GetMFAAuthenticationStatus	查询用户的MFA启用状态	查询用户的多因素认证（MFA）启用状态。