首页 云SSO API参考 API概览

API概览

本产品(访问控制 云SSO/2021-05-15)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

管理云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删除目录。

管理用户

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配置。

管理用户组

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查询异步任务的状态。

其他(不维护)

API标题API概述
SetMFAAuthenticationStatus为目录中的用户启用或禁用MFA调用SetMFAAuthenticationStatus为目录中的用户启用或禁用多因素认证(MFA)。
GetMFAAuthenticationStatus查询用户的MFA启用状态查询用户的多因素认证(MFA)启用状态。
阿里云首页 云SSO 相关技术圈