全部API介面參考手冊-雲SSO-阿里雲 - CloudSSO

API標準及多語言預置SDK

本產品（cloudsso/2021-05-15）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

管理雲端 SSO

API	標題	API概述
EnableService	開通雲SSO	調用EnableService開通雲SSO。
DisableService	關閉雲SSO	調用DisableService關閉雲SSO。
GetServiceStatus	查詢雲SSO狀態	調用GetServiceStatus查詢雲SSO狀態。
ListDirectories	查詢目錄列表	調用ListDirectories查詢目錄列表。
GetDirectory	查詢目錄資訊	調用GetDirectory查詢目錄資訊。
GetDirectoryStatistics	查詢目錄的統計資訊	調用GetDirectoryStatistics查詢目錄的統計資訊。
UpdateDirectory	修改目錄名稱	調用UpdateDirectory修改目錄名稱。
EnableDelegateAccount	啟用雲SSO委派管理員帳號	調用EnableDelegateAccount啟用雲SSO委派管理員帳號。
DisableDelegateAccount	禁用雲SSO委派管理員帳號	調用DisableDelegateAccount禁用雲SSO委派管理員帳號。

管理使用者

API	標題	API概述
UpdateUserStatus	修改使用者狀態	調用UpdateUserStatus修改使用者狀態。
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概述
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帳號上的授權。

管理 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）啟用狀態。

其他

API	標題	API概述
CreateDirectory	建立目錄	調用CreateDirectory建立目錄。
CreateGroup	建立使用者組	調用CreateGroup建立使用者組。
CreateUser	建立使用者	調用CreateUser建立使用者。
DeleteDirectory	刪除目錄	調用DeleteDirectory刪除目錄。
DeleteGroup	刪除使用者組	調用DeleteGroup刪除指定使用者組。
DeleteUser	刪除使用者	調用DeleteUser刪除使用者。
GetGroup	查詢使用者組資訊	調用GetGroup查詢指定使用者組資訊。
GetTask	查詢非同步任務資訊	調用GetTask查詢非同步任務資訊。
GetTaskStatus	查詢非同步任務的狀態	調用GetTaskStatus查詢非同步任務的狀態。
GetUser	查詢使用者資訊	調用GetUser查詢指定使用者資訊。
ListGroups	查詢使用者組列表	調用ListGroups查詢使用者組列表。
ListTasks	查詢非同步工作清單	調用ListTasks查詢非同步工作清單。
ListUsers	查詢使用者列表	調用ListUsers查詢使用者列表。
ResetUserPassword	重設使用者密碼	調用ResetUserPassword重設使用者密碼。
UpdateGroup	修改使用者組資訊	調用UpdateGroup修改使用者組資訊。
UpdateUser	修改使用者資訊	調用UpdateUser修改使用者資訊。