Todos os produtos
Search
Central de documentação

CloudSSO:Visão geral da API

Última atualização: Jul 03, 2026

Padrões de API e SDKs predefinidos multilíngues

A OpenAPI deste produto (cloudsso/2021-05-15) utiliza o estilo de assinatura RPC. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.

Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.

Cenários de assinatura personalizada

Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.

Preparação de conta e segurança

As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.

Gerenciar CloudSSO

API

Título

Descrição

EnableService EnableService. Ativa o CloudSSO.
DisableService DisableService. Desativa o CloudSSO.
GetServiceStatus GetServiceStatus. Consulta o status do CloudSSO.

Gerenciar usuários

API

Título

Descrição

UpdateUserStatus UpdateUserStatus. Altera o status de um usuário.
DeleteMFADeviceForUser DeleteMFADeviceForUser. Desvincula um dispositivo de autenticação multifator (MFA) de um usuário.
UpdateUserMFAAuthenticationSettings UpdateUserMFAAuthenticationSettings. Modifica a configuração de autenticação multifator (MFA) de um único usuário.
GetUserId GetUserId. Consulta o ID de um usuário em um diretório de recursos usando o parâmetro ExternalId.

Gerenciar grupos de usuários

API

Título

Descrição

AddUserToGroup AddUserToGroup. Adiciona um usuário a um grupo.

Gerenciar sincronização SCIM

API

Título

Descrição

CreateSCIMServerCredential CreateSCIMServerCredential. Cria uma credencial SCIM (System for Cross-domain Identity Management).
UpdateSCIMServerCredentialStatus UpdateSCIMServerCredentialStatus. Ativa ou desativa uma credencial do System for Cross-domain Identity Management (SCIM).
DeleteSCIMServerCredential DeleteSCIMServerCredential. Exclui uma credencial SCIM (System for Cross-domain Identity Management).

Gerenciar single sign-on

API

Título

Descrição

CreateAccessConfiguration CreateAccessConfiguration. Cria uma configuração de acesso.
ListAccessConfigurations ListAccessConfigurations. Consulta uma lista de configurações de acesso.
GetAccessConfiguration GetAccessConfiguration. Consulta os detalhes de uma configuração de acesso.
UpdateAccessConfiguration UpdateAccessConfiguration. Modifica informações sobre uma configuração de acesso.
DeleteAccessConfiguration DeleteAccessConfiguration Exclui uma configuração de acesso.
AddPermissionPolicyToAccessConfiguration AddPermissionPolicyToAccessConfiguration. Adiciona uma política a uma configuração de acesso.
RemovePermissionPolicyFromAccessConfiguration RemovePermissionPolicyFromAccessConfiguration. Remove uma política de uma configuração de acesso.
UpdateInlinePolicyForAccessConfiguration UpdateInlinePolicyForAccessConfiguration. Modifica uma política inline criada para uma configuração de acesso.

Gerenciar configurações de acesso

API

Título

Descrição

ProvisionAccessConfiguration ProvisionAccessConfiguration. Provisiona uma configuração de acesso para uma conta em seu diretório de recursos.
DeprovisionAccessConfiguration DeprovisionAccessConfiguration. Desprovisiona uma configuração de acesso de uma conta em seu diretório de recursos.
ListAccessConfigurationProvisionings ListAccessConfigurationProvisionings. Consulta as configurações de acesso provisionadas.
CreateAccessAssignment CreateAccessAssignment. Atribui permissões de acesso em uma conta no seu diretório de recursos a um usuário ou grupo usando uma configuração de acesso.
ListAccessAssignments ListAccessAssignments. Consulta as permissões de acesso atribuídas.
DeleteAccessAssignment DeleteAccessAssignment. Remove as permissões de acesso de uma conta em um diretório de recursos.

Gerenciar autorização multiconta

API

Título

Descrição

CreateUserProvisioning CreateUserProvisioning. Cria um provisionamento de usuário do Resource Access Management (RAM).
ListUserProvisionings ListUserProvisionings. Consulta os provisionamentos de usuários do Resource Access Management (RAM).
UpdateUserProvisioning UpdateUserProvisioning. Modifica um provisionamento de usuário do Resource Access Management (RAM).
DeleteUserProvisioning DeleteUserProvisioning. Exclui um provisionamento de usuário do Resource Access Management (RAM).
ListUserProvisioningEvents ListUserProvisioningEvents. Consulta os eventos de provisionamento de usuários do Resource Access Management (RAM).

Gerenciar sincronização de usuários RAM

API

Título

Descrição

AddExternalSAMLIdPCertificate AddExternalSAMLIdPCertificate. Adiciona um certificado de assinatura Security Assertion Markup Language (SAML).
ClearExternalSAMLIdentityProvider ClearExternalSAMLIdentityProvider. Limpa as configurações de um provedor de identidade (IdP) de Security Assertion Markup Language (SAML).
CreateDirectory CreateDirectory. Cria um diretório.
CreateGroup CreateGroup. Cria um grupo.
CreateUser CreateUser. Cria um usuário.
DeleteDirectory Excluir um diretório. Exclui um diretório.
DeleteGroup DeleteGroup. Exclui um grupo.
DeleteUser DeleteUser. Exclui um usuário.
DeleteUserProvisioningEvent DeleteUserProvisioningEvent. Exclui um evento de provisionamento de usuário do Resource Access Management (RAM).
DisableDelegateAccount DisableDelegateAccount. Desativa a conta de administrador delegado do CloudSSO.
EnableDelegateAccount EnableDelegateAccount. Ativa a conta de administrador delegado do CloudSSO.
GetDirectory GetDirectory. Consulta informações sobre um diretório.
GetDirectorySAMLServiceProviderInfo GetDirectorySAMLServiceProviderInfo. Consulta informações sobre um provedor de serviços (SP) Security Assertion Markup Language (SAML).
GetDirectoryStatistics GetDirectoryStatistics. Consulta as estatísticas de um diretório.
GetExternalSAMLIdentityProvider GetExternalSAMLIdentityProvider. Consulta as configurações de um provedor de identidade (IdP) de Security Assertion Markup Language (SAML).
GetGroup GetGroup. Consulta as informações de um grupo.
GetLoginPreference GetLoginPreference. Consulta a preferência de logon dos usuários do CloudSSO.
GetMFAAuthenticationSettingInfo GetMFAAuthenticationSettingInfo. Consulta a configuração de autenticação multifator (MFA) de todos os usuários.
GetMFAAuthenticationSettings GetMFAAuthenticationSettings. Consulta a configuração de autenticação multifator (MFA) de todos os usuários.
GetMFAAuthenticationStatus GetMFAAuthenticationStatus. Verifica se a autenticação multifator (MFA) está ativada para os usuários.
GetPasswordPolicy GetPasswordPolicy. Consulta a política de senha dos usuários do CloudSSO.
GetSCIMSynchronizationStatus GetSCIMSynchronizationStatus. Consulta o status da sincronização do System for Cross-domain Identity Management (SCIM).
GetTask GetTask. Consulta informações sobre uma tarefa assíncrona.
GetTaskStatus GetTaskStatus. Consulta o status de uma tarefa assíncrona.
GetUser GetUser. Consulta as informações de um usuário.
GetUserMFAAuthenticationSettings GetUserMFAAuthenticationSettings. Consulta a configuração de autenticação multifator (MFA) de um único usuário.
GetUserProvisioning GetUserProvisioning. Consulta um provisionamento de usuário do Resource Access Management (RAM).
GetUserProvisioningConfiguration GetUserProvisioningConfiguration. Consulta as configurações globais de um provisionamento de usuário do Resource Access Management (RAM).
GetUserProvisioningEvent GetUserProvisioningEvent. Consulta as informações sobre um provisionamento de usuário do Resource Access Management (RAM).
GetUserProvisioningRdAccountStatistics GetUserProvisioningRdAccountStatistics. Consulta estatísticas de eventos de provisionamento de usuários do Resource Access Management (RAM) criados para o membro em um diretório de recursos.
GetUserProvisioningStatistics GetUserProvisioningStatistics. Consulta as estatísticas de um provisionamento de usuário do Resource Access Management (RAM).
ListDirectories ListDirectories. Consulta diretórios.
ListExternalSAMLIdPCertificates ListExternalSAMLIdPCertificates. Consulta os certificados de assinatura SAML.
ListGroupMembers ListGroupMembers. Consulta os usuários de um grupo.
ListGroups ListGroups. Consulta os grupos.
ListJoinedGroupsForUser ListJoinedGroupsForUser. Consulta os grupos aos quais um usuário foi adicionado.
ListMFADevicesForUser ListMFADevicesForUser. Consulta os dispositivos de autenticação multifator (MFA) vinculados a um usuário. Até dois dispositivos MFA podem ser vinculados a um usuário.
ListPermissionPoliciesInAccessConfiguration ListPermissionPoliciesInAccessConfiguration. Consulta as políticas criadas para uma configuração de acesso.
ListSCIMServerCredentials ListSCIMServerCredentials. Consulta credenciais de Cross-domain Identity Management (SCIM).
ListTasks ListTasks. Consulta tarefas assíncronas.
ListUsers ListUsers. Consulta uma lista de usuários.
RemoveExternalSAMLIdPCertificate RemoveExternalSAMLIdPCertificate. Remove um certificado de assinatura Security Assertion Markup Language (SAML).
RemoveUserFromGroup RemoveUserFromGroup. Remove um usuário de um grupo.
ResetUserPassword ResetUserPassword. Redefine a senha de um usuário.
RetryUserProvisioningEvent RetryUserProvisioningEvent. Tenta novamente um evento de provisionamento de usuário do Resource Access Management (RAM).
SetExternalSAMLIdentityProvider SetExternalSAMLIdentityProvider. Configura um provedor de identidade (IdP) de Security Assertion Markup Language (SAML).
SetLoginPreference Configurar preferência de logon. Configura a preferência de logon dos usuários do CloudSSO.
SetMFAAuthenticationStatus Definir status de autenticação MFA. Ativa ou desativa a autenticação multifator (MFA) para usuários em um diretório.
SetPasswordPolicy SetPasswordPolicy. Configura uma política de senha para usuários do CloudSSO.
SetSCIMSynchronizationStatus SetSCIMSynchronizationStatus. Ativa ou desativa a sincronização do System for Cross-domain Identity Management (SCIM).
UpdateDirectory UpdateDirectory. Altera o nome de um diretório.
UpdateGroup UpdateGroup. Modifica as informações sobre um grupo.
UpdateMFAAuthenticationSettings UpdateMFAAuthenticationSettings. Modifica a configuração de autenticação multifator (MFA) de todos os usuários.
UpdateUser UpdateUser. Modifica as informações de um usuário.
UpdateUserProvisioningConfiguration UpdateUserProvisioningConfiguration. Modifica as configurações globais do provisionamento de usuários do Resource Access Management (RAM).