本產(chǎn)品（
云SSO/2021-05-15）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機(jī)制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（11370001915），在專家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請(qǐng)參見獲取AccessKey。
管理云SSO
| API | 標(biāo)題 | API概述 |
|---|---|---|
| EnableService | 開通云SSO | 調(diào)用EnableService開通云SSO。 |
| DisableService | 關(guān)閉云SSO | 調(diào)用DisableService關(guān)閉云SSO。 |
| GetServiceStatus | 查詢?cè)芐SO狀態(tài) | 調(diào)用GetServiceStatus查詢?cè)芐SO狀態(tài)。 |
| CreateDirectory | 創(chuàng)建目錄 | 調(diào)用CreateDirectory創(chuàng)建目錄。 |
| ListDirectories | 查詢目錄列表 | 調(diào)用ListDirectories查詢目錄列表。 |
| GetDirectory | 查詢目錄信息 | 調(diào)用GetDirectory查詢目錄信息。 |
| GetDirectoryStatistics | 查詢目錄的統(tǒng)計(jì)信息 | 調(diào)用GetDirectoryStatistics查詢目錄的統(tǒng)計(jì)信息。 |
| UpdateDirectory | 修改目錄名稱 | 調(diào)用UpdateDirectory修改目錄名稱。 |
| DeleteDirectory | 刪除目錄 | 調(diào)用DeleteDirectory刪除目錄。 |
| EnableDelegateAccount | 啟用云SSO委派管理員賬號(hào) | 調(diào)用EnableDelegateAccount啟用云SSO委派管理員賬號(hào)。 |
| DisableDelegateAccount | 禁用云SSO委派管理員賬號(hào) | 調(diào)用DisableDelegateAccount禁用云SSO委派管理員賬號(hào)。 |
管理用戶
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateUser | 創(chuàng)建用戶 | 調(diào)用CreateUser創(chuàng)建用戶。 |
| ListUsers | 查詢用戶列表 | 調(diào)用ListUsers查詢用戶列表。 |
| GetUser | 查詢用戶信息 | 調(diào)用GetUser查詢指定用戶信息。 |
| UpdateUser | 修改用戶信息 | 調(diào)用UpdateUser修改用戶信息。 |
| UpdateUserStatus | 修改用戶狀態(tài) | 調(diào)用UpdateUserStatus修改用戶狀態(tài)。 |
| DeleteUser | 刪除用戶 | 調(diào)用DeleteUser刪除用戶。 |
| ResetUserPassword | 重置用戶密碼 | 調(diào)用ResetUserPassword重置用戶密碼。 |
| ListMFADevicesForUser | 查詢用戶的MFA設(shè)備列表 | 調(diào)用ListMFADevicesForUser查詢用戶的MFA設(shè)備列表。每個(gè)用戶最多只能有2個(gè)MFA設(shè)備。 |
| DeleteMFADeviceForUser | 刪除用戶的MFA設(shè)備 | 調(diào)用DeleteMFADeviceForUser刪除用戶的MFA設(shè)備。 |
| UpdateMFAAuthenticationSettings | 修改全局MFA配置 | 調(diào)用UpdateMFAAuthenticationSettings修改全局MFA配置。 |
| GetMFAAuthenticationSettings | 查詢?nèi)諱FA配置 | 調(diào)用GetMFAAuthenticationSettings查詢?nèi)諱FA配置。 |
| UpdateUserMFAAuthenticationSettings | 修改用戶MFA獨(dú)立配置 | 調(diào)用UpdateUserMFAAuthenticationSettings修改用戶MFA獨(dú)立配置。 |
| GetUserMFAAuthenticationSettings | 查詢用戶MFA獨(dú)立配置 | 調(diào)用GetUserMFAAuthenticationSettings查詢用戶MFA獨(dú)立配置。 |
| GetMFAAuthenticationSettingInfo | 查詢?nèi)諱FA配置 | 調(diào)用GetMFAAuthenticationSettingInfo查詢?nèi)諱FA配置。 |
| SetLoginPreference | 設(shè)置登錄偏好 | 調(diào)用SetLoginPreference設(shè)置云SSO用戶的登錄偏好。 |
| GetLoginPreference | 查詢登錄偏好 | 調(diào)用GetLoginPreference查詢登錄偏好。 |
| SetPasswordPolicy | 設(shè)置密碼策略 | 調(diào)用SetPasswordPolicy設(shè)置云SSO用戶的密碼策略。 |
| GetPasswordPolicy | 查詢密碼策略 | 調(diào)用GetPasswordPolicy查詢?cè)芐SO用戶的密碼策略。 |
| GetUserId | 通過ExternalId獲取用戶ID | 調(diào)用GetUserId通過ExternalId獲取目錄下對(duì)應(yīng)的用戶ID。 |
管理用戶組
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateGroup | 創(chuàng)建用戶組 | 調(diào)用CreateGroup創(chuàng)建用戶組。 |
| ListGroups | 查詢用戶組列表 | 調(diào)用ListGroups查詢用戶組列表。 |
| GetGroup | 查詢用戶組信息 | 調(diào)用GetGroup查詢指定用戶組信息。 |
| UpdateGroup | 修改用戶組信息 | 調(diào)用UpdateGroup修改用戶組信息。 |
| DeleteGroup | 刪除用戶組 | 調(diào)用DeleteGroup刪除指定用戶組。 |
| AddUserToGroup | 為用戶組添加用戶 | 調(diào)用AddUserToGroup為用戶組添加用戶。 |
| RemoveUserFromGroup | 從用戶組中移除用戶 | 從用戶組中移除用戶。 |
| ListJoinedGroupsForUser | 查詢用戶加入的用戶組 | 查詢用戶加入的用戶組。 |
| ListGroupMembers | 查詢用戶組中的用戶列表 | 查詢用戶組中的用戶列表。 |
管理SCIM同步
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateSCIMServerCredential | 創(chuàng)建SCIM密鑰 | 調(diào)用CreateSCIMServerCredential創(chuàng)建SCIM密鑰。 |
| ListSCIMServerCredentials | 查詢SCIM密鑰列表 | 調(diào)用ListSCIMServerCredentials查詢SCIM密鑰列表。 |
| UpdateSCIMServerCredentialStatus | 啟用或禁用SCIM密鑰 | 調(diào)用UpdateSCIMServerCredentialStatus啟用或禁用SCIM密鑰。 |
| DeleteSCIMServerCredential | 刪除SCIM密鑰 | 調(diào)用DeleteSCIMServerCredential刪除SCIM密鑰。 |
| SetSCIMSynchronizationStatus | 啟用或禁用SCIM同步 | 調(diào)用SetSCIMSynchronizationStatus啟用或禁用SCIM同步。 |
| GetSCIMSynchronizationStatus | 查詢SCIM同步狀態(tài) | 調(diào)用GetSCIMSynchronizationStatus查詢SCIM同步的狀態(tài)。 |
管理單點(diǎn)登錄
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GetDirectorySAMLServiceProviderInfo | 查詢SAML服務(wù)提供商信息 | 調(diào)用GetDirectorySAMLServiceProviderInfo查詢SAML服務(wù)提供商（SP）信息。 |
| SetExternalSAMLIdentityProvider | 配置SAML身份提供商信息 | 調(diào)用SetExternalSAMLIdentityProvider配置SAML身份提供商（IdP）信息。 |
| GetExternalSAMLIdentityProvider | 查詢SAML身份提供商配置信息 | 調(diào)用GetExternalSAMLIdentityProvider查詢SAML身份提供商（IdP）的配置信息。 |
| ClearExternalSAMLIdentityProvider | 清空SAML身份提供商配置信息 | 調(diào)用ClearExternalSAMLIdentityProvider清空SAML身份提供商（IdP）的配置信息。 |
| AddExternalSAMLIdPCertificate | 添加SAML簽名證書 | 調(diào)用AddExternalSAMLIdPCertificate添加SAML簽名證書。 |
| ListExternalSAMLIdPCertificates | 查詢SAML簽名證書列表 | 調(diào)用ListExternalSAMLIdPCertificates查詢SAML簽名證書列表。 |
| RemoveExternalSAMLIdPCertificate | 移除SAML簽名證書 | 調(diào)用RemoveExternalSAMLIdPCertificate移除SAML簽名證書。 |
管理訪問配置
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAccessConfiguration | 創(chuàng)建訪問配置 | 創(chuàng)建訪問配置。 |
| ListAccessConfigurations | 查詢?cè)L問配置列表 | 調(diào)用ListAccessConfigurations查詢?cè)L問配置列表。 |
| GetAccessConfiguration | 查詢?cè)L問配置信息 | 調(diào)用GetAccessConfiguration查詢?cè)L問配置信息。 |
| UpdateAccessConfiguration | 修改訪問配置信息 | 調(diào)用UpdateAccessConfiguration修改訪問配置信息。 |
| DeleteAccessConfiguration | 刪除訪問配置 | 調(diào)用DeleteAccessConfiguration刪除訪問配置。 |
| AddPermissionPolicyToAccessConfiguration | 為訪問配置添加權(quán)限策略 | 為訪問配置添加權(quán)限策略。 |
| RemovePermissionPolicyFromAccessConfiguration | 為訪問配置移除權(quán)限策略 | 為訪問配置移除權(quán)限策略。 |
| UpdateInlinePolicyForAccessConfiguration | 修改訪問配置的內(nèi)置策略 | 調(diào)用UpdateInlinePolicyForAccessConfiguration修改訪問配置的內(nèi)置策略。 |
| ListPermissionPoliciesInAccessConfiguration | 查詢?cè)L問配置中的權(quán)限策略列表 | 查詢?cè)L問配置中的權(quán)限策略列表。 |
管理多賬號(hào)授權(quán)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ProvisionAccessConfiguration | 將訪問配置部署到RD賬號(hào)上 | 調(diào)用ProvisionAccessConfiguration將訪問配置部署到RD賬號(hào)上。 |
| DeprovisionAccessConfiguration | 解除訪問配置在RD賬號(hào)上的部署 | 調(diào)用DeprovisionAccessConfiguration解除訪問配置在RD賬號(hào)上的部署。 |
| ListAccessConfigurationProvisionings | 查詢?cè)L問配置部署列表 | 調(diào)用ListAccessConfigurationProvisionings查詢?cè)L問配置部署列表。 |
| CreateAccessAssignment | 在RD賬號(hào)上授權(quán) | 為RD賬號(hào)設(shè)置允許訪問的用戶或用戶組，以及對(duì)應(yīng)的訪問權(quán)限（訪問配置）。 |
| ListAccessAssignments | 查詢授權(quán)列表 | 調(diào)用ListAccessAssignments查詢授權(quán)列表。 |
| DeleteAccessAssignment | 移除RD賬號(hào)上的授權(quán) | 調(diào)用DeleteAccessAssignment移除RD賬號(hào)上的授權(quán)。 |
| ListTasks | 查詢異步任務(wù)列表 | 調(diào)用ListTasks查詢異步任務(wù)列表。 |
| GetTask | 查詢異步任務(wù)信息 | 調(diào)用GetTask查詢異步任務(wù)信息。 |
| GetTaskStatus | 查詢異步任務(wù)的狀態(tài) | 調(diào)用GetTaskStatus查詢異步任務(wù)的狀態(tài)。 |
管理RAM用戶同步
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateUserProvisioning | 創(chuàng)建RAM用戶同步 | 調(diào)用CreateUserProvisioning創(chuàng)建RAM用戶同步。 |
| GetUserProvisioning | 查詢RAM用戶同步 | 調(diào)用GetUserProvisioning查詢RAM用戶同步信息。 |
| ListUserProvisionings | 查詢RAM用戶同步列表 | 調(diào)用ListUserProvisionings查詢RAM用戶同步列表。 |
| UpdateUserProvisioning | 修改RAM用戶同步 | 調(diào)用UpdateUserProvisioning修改RAM用戶同步。 |
| DeleteUserProvisioning | 刪除RAM用戶同步 | 調(diào)用DeleteUserProvisioning刪除RAM用戶同步。 |
| UpdateUserProvisioningConfiguration | 修改RAM用戶同步全局配置 | 調(diào)用UpdateUserProvisioningConfiguration修改RAM用戶同步全局配置。 |
| GetUserProvisioningConfiguration | 查詢RAM用戶同步全局配置 | 調(diào)用GetUserProvisioningConfiguration查詢RAM用戶同步全局配置。 |
| ListUserProvisioningEvents | 查詢RAM用戶同步事件列表 | 調(diào)用ListUserProvisioningEvents查詢執(zhí)行失敗的RAM用戶同步事件列表。 |
| GetUserProvisioningEvent | 查詢RAM用戶同步事件 | 調(diào)用GetUserProvisioningEvent查詢執(zhí)行失敗的RAM用戶同步事件。 |
| DeleteUserProvisioningEvent | 刪除RAM用戶同步事件 | 調(diào)用DeleteUserProvisioningEvent刪除執(zhí)行失敗的RAM用戶同步事件。 |
| RetryUserProvisioningEvent | 重試RAM用戶同步事件 | 調(diào)用RetryUserProvisioningEvent重試執(zhí)行失敗的RAM用戶同步事件。 |
| GetUserProvisioningStatistics | 查詢RAM用戶同步的統(tǒng)計(jì)信息 | 調(diào)用GetUserProvisioningStatistics查詢RAM用戶同步的統(tǒng)計(jì)信息。 |
| GetUserProvisioningRdAccountStatistics | 查詢資源目錄成員的RAM用戶同步統(tǒng)計(jì)信息 | 調(diào)用GetUserProvisioningRdAccountStatistics查詢資源目錄成員賬號(hào)中的RAM用戶同步任務(wù)統(tǒng)計(jì)信息。 |
其他（不維護(hù)）
| API | 標(biāo)題 | API概述 |
|---|---|---|
| SetMFAAuthenticationStatus | 為目錄中的用戶啟用或禁用MFA | 調(diào)用SetMFAAuthenticationStatus為目錄中的用戶啟用或禁用多因素認(rèn)證（MFA）。 |
| GetMFAAuthenticationStatus | 查詢用戶的MFA啟用狀態(tài) | 查詢用戶的多因素認(rèn)證（MFA）啟用狀態(tài)。 |