All Products
Search
Document Center

CloudSSO:List of operations by function

Last Updated:Mar 17, 2023
This product(cloudsso/2021-05-15) OpenAPI adopts RPC Signature style, see signature details Description of the signature mechanism.We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our service nail group (11370001915) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

CloudSSO

APITitleDescription
EnableServiceEnableServiceEnables CloudSSO.
DisableServiceDisableServiceDisables CloudSSO.
GetServiceStatusGetServiceStatusQueries the status of CloudSSO.
CreateDirectoryCreateDirectoryCreates a directory.
ListDirectoriesListDirectoriesQueries directories.
GetDirectoryGetDirectoryQueries information about a directory.
GetDirectoryStatisticsGetDirectoryStatisticsQueries the statistics of a directory.
UpdateDirectoryUpdateDirectoryChanges the name of a directory.
DeleteDirectoryDeleteDirectoryDeletes a directory.

Users

APITitleDescription
CreateUserCreateUserCreates a user.
ListUsersListUsersQueries users.
GetUserGetUserQueries information about a user.
UpdateUserUpdateUserModifies information about a user.
UpdateUserStatusUpdateUserStatusChanges the status of a user.
DeleteUserDeleteUserDeletes a user.
ResetUserPasswordResetUserPasswordResets the password of a user.
ListMFADevicesForUserListMFADevicesForUserQueries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
DeleteMFADeviceForUserDeleteMFADeviceForUserUnbinds a multi-factor authentication (MFA) device from a user.
UpdateMFAAuthenticationSettingsUpdateMFAAuthenticationSettingsModifies the multi-factor authentication (MFA) setting of all users.
GetMFAAuthenticationSettingsGetMFAAuthenticationSettingsQueries the multi-factor authentication (MFA) setting of all users.
UpdateUserMFAAuthenticationSettingsUpdateUserMFAAuthenticationSettingsModifies the multi-factor authentication (MFA) setting of a singe user.
GetUserMFAAuthenticationSettingsGetUserMFAAuthenticationSettingsQueries the multi-factor authentication (MFA) setting of a singe user.
GetMFAAuthenticationSettingInfoGetMFAAuthenticationSettingInfoQueries the multi-factor authentication (MFA) setting of all users.

Groups

APITitleDescription
CreateGroupCreateGroupCreates a group.
ListGroupsListGroupsQueries groups.
GetGroupGetGroupQueries information about a group.
UpdateGroupUpdateGroupModifies information about a group.
DeleteGroupDeleteGroupDeletes a group.
AddUserToGroupAddUserToGroupAdds a user to a group.
RemoveUserFromGroupRemoveUserFromGroupRemoves a user from a group.
ListJoinedGroupsForUserListJoinedGroupsForUserQueries the groups to which a user is added.
ListGroupMembersListGroupMembersQueries the users in a group.

SCIM synchronization

APITitleDescription
CreateSCIMServerCredentialCreateSCIMServerCredentialCreates a Cross-domain Identity Management (SCIM) credential.
ListSCIMServerCredentialsListSCIMServerCredentialsQueries Cross-domain Identity Management (SCIM) credentials.
UpdateSCIMServerCredentialStatusUpdateSCIMServerCredentialStatusEnables or disables a Cross-domain Identity Management (SCIM) credential.
DeleteSCIMServerCredentialDeleteSCIMServerCredentialDeletes a Cross-domain Identity Management (SCIM) credential.
SetSCIMSynchronizationStatusSetSCIMSynchronizationStatusEnables or disables Cross-domain Identity Management (SCIM) synchronization.
GetSCIMSynchronizationStatusGetSCIMSynchronizationStatusQueries the status of System for Cross-domain Identity Management (SCIM) synchronization.

SSO logon

APITitleDescription
GetDirectorySAMLServiceProviderInfoGetDirectorySAMLServiceProviderInfoQueries information about a Security Assertion Markup Language (SAML) service provider (SP).
SetExternalSAMLIdentityProviderSetExternalSAMLIdentityProviderConfigures a Security Assertion Markup Language (SAML) identity provider (IdP).
GetExternalSAMLIdentityProviderGetExternalSAMLIdentityProviderQueries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
ClearExternalSAMLIdentityProviderClearExternalSAMLIdentityProviderClears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
AddExternalSAMLIdPCertificateAddExternalSAMLIdPCertificateAdds a Security Assertion Markup Language (SAML) signing certificate.
ListExternalSAMLIdPCertificatesListExternalSAMLIdPCertificatesQueries Security Assertion Markup Language (SAML) signing certificates.
RemoveExternalSAMLIdPCertificateRemoveExternalSAMLIdPCertificateRemoves a Security Assertion Markup Language (SAML) signing certificate.

Access configurations

APITitleDescription
CreateAccessConfigurationCreateAccessConfigurationCreates an access configuration.
ListAccessConfigurationsListAccessConfigurationsQueries access configurations.
GetAccessConfigurationGetAccessConfigurationQueries information about an access configuration.
UpdateAccessConfigurationUpdateAccessConfigurationModifies information about an access configuration.
DeleteAccessConfigurationDeleteAccessConfigurationDeletes an access configuration.
AddPermissionPolicyToAccessConfigurationAddPermissionPolicyToAccessConfigurationAdds a policy to an access configuration.
RemovePermissionPolicyFromAccessConfigurationRemovePermissionPolicyFromAccessConfigurationRemoves a policy from an access configuration.
UpdateInlinePolicyForAccessConfigurationUpdateInlinePolicyForAccessConfigurationModifies an inline policy that is created for an access configuration.
ListPermissionPoliciesInAccessConfigurationListPermissionPoliciesInAccessConfigurationQueries the policies that are created for an access configuration.

Multi-account authorization

APITitleDescription
ProvisionAccessConfigurationProvisionAccessConfigurationProvisions an access configuration for an account in your resource directory.
DeprovisionAccessConfigurationDeprovisionAccessConfigurationDe-provisions an access configuration from an account in your resource directory.
ListAccessConfigurationProvisioningsListAccessConfigurationProvisioningsQueries the accounts for which access permissions are provisioned.
CreateAccessAssignmentCreateAccessAssignmentAssigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
ListAccessAssignmentsListAccessAssignmentsQueries the access permissions that are assigned.
DeleteAccessAssignmentDeleteAccessAssignmentRemove the access permissions on an account in a resource directory.
ListTasksListTasksQueries asynchronous tasks.
GetTaskGetTaskQueries information about an asynchronous task.
GetTaskStatusGetTaskStatusQueries the status of an asynchronous task.

Others (not maintained)

APITitleDescription
SetMFAAuthenticationStatusSetMFAAuthenticationStatusEnables or disables multi-factor authentication (MFA) for users in a directory.
GetMFAAuthenticationStatusGetMFAAuthenticationStatusChecks whether multi-factor authentication (MFA) is enabled for users.