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.
Gerenciamento do CloudSSO
|
API |
Título |
Descrição |
| EnableService | EnableService. | Ativa o CloudSSO. |
| DisableService | DisableService. | Desativa o CloudSSO. |
| GetServiceStatus | GetServiceStatus. | Consulta o status do CloudSSO. |
| ListDirectories | ListDirectories. | Consulta diretórios. |
| GetDirectory | Consulta de informações do diretório | Consulta os detalhes de um diretório. |
| GetDirectoryStatistics | GetDirectoryStatistics. | Consulta as estatísticas de um diretório. |
| UpdateDirectory | UpdateDirectory. | Altera o nome de um diretório. |
| EnableDelegateAccount | Ativar uma conta de administrador delegado do CloudSSO | Ativa uma conta de administrador delegado do CloudSSO. |
| DisableDelegateAccount | DisableDelegateAccount. | Desativa a conta de administrador delegado do CloudSSO. |
Gerenciamento de usuários
|
API |
Título |
Descrição |
| UpdateUserStatus | UpdateUserStatus. | Altera o status de um usuário. |
| ListMFADevicesForUser | Consultar dispositivos MFA de um usuário. | Consulta a lista de dispositivos MFA de um usuário. Cada usuário pode ter no máximo dois dispositivos MFA. |
| DeleteMFADeviceForUser | Excluir o dispositivo MFA de um usuário. | Exclui o dispositivo MFA de um usuário. |
| UpdateMFAAuthenticationSettings | Modify global MFA settings. | Modifica as configurações globais de autenticação multifator (MFA). |
| GetMFAAuthenticationSettings | GetMFAAuthenticationSettings. | Consulta a configuração de autenticação multifator (MFA) de todos os usuários. |
| UpdateUserMFAAuthenticationSettings | UpdateUserMFAAuthenticationSettings. | Modifica a configuração de autenticação multifator (MFA) de um único usuário. |
| GetUserMFAAuthenticationSettings | GetUserMFAAuthenticationSettings. | Consulta a configuração de autenticação multifator (MFA) de um único usuário. |
| GetMFAAuthenticationSettingInfo | Consultar configuração global de MFA. | Consulta a configuração global de autenticação multifator (MFA). |
| SetLoginPreference | Configurar preferência de logon. | Configura a preferência de logon dos usuários do CloudSSO. |
| GetLoginPreference | GetLoginPreference. | Consulta a preferência de logon dos usuários do CloudSSO. |
| SetPasswordPolicy | SetPasswordPolicy. | Configura uma política de senha para usuários do CloudSSO. |
| GetPasswordPolicy | GetPasswordPolicy. | Consulta a política de senha dos usuários do CloudSSO. |
| GetUserId | GetUserId. | Consulta o ID de um usuário em um diretório de recursos usando o parâmetro ExternalId. |
Gerenciamento de grupos de usuários
|
API |
Título |
Descrição |
| AddUserToGroup | Adicionar um usuário a um grupo | Adiciona um usuário a um grupo. |
| RemoveUserFromGroup | RemoveUserFromGroup. | Remove um usuário de um grupo. |
| ListJoinedGroupsForUser | ListJoinedGroupsForUser. | Consulta os grupos aos quais um usuário foi adicionado. |
| ListGroupMembers | ListGroupMembers. | Consulta os usuários de um grupo. |
Gerenciamento da sincronização SCIM
|
API |
Título |
Descrição |
| CreateSCIMServerCredential | Criar uma credencial SCIM | Cria uma credencial SCIM. |
| ListSCIMServerCredentials | ListSCIMServerCredentials. | Consulta credenciais de Cross-domain Identity Management (SCIM). |
| UpdateSCIMServerCredentialStatus | Ativar ou desativar uma credencial SCIM | Ativa ou desativa uma credencial SCIM. |
| DeleteSCIMServerCredential | Excluir uma credencial SCIM | Exclui uma credencial SCIM. |
| SetSCIMSynchronizationStatus | SetSCIMSynchronizationStatus. | Ativa ou desativa a sincronização do System for Cross-domain Identity Management (SCIM). |
| GetSCIMSynchronizationStatus | GetSCIMSynchronizationStatus. | Consulta o status da sincronização do System for Cross-domain Identity Management (SCIM). |
Gerenciamento de logon único
|
API |
Título |
Descrição |
| GetDirectorySAMLServiceProviderInfo | GetDirectorySAMLServiceProviderInfo. | Consulta informações sobre um provedor de serviços (SP) Security Assertion Markup Language (SAML). |
| SetExternalSAMLIdentityProvider | SetExternalSAMLIdentityProvider. | Configura um provedor de identidade (IdP) de Security Assertion Markup Language (SAML). |
| GetExternalSAMLIdentityProvider | GetExternalSAMLIdentityProvider. | Consulta as configurações de um provedor de identidade (IdP) de Security Assertion Markup Language (SAML). |
| ClearExternalSAMLIdentityProvider | Limpar configuração do IdP SAML | Limpa a configuração do IdP SAML. |
| AddExternalSAMLIdPCertificate | Adicionar um certificado de assinatura SAML | Adiciona um certificado de assinatura SAML. |
| ListExternalSAMLIdPCertificates | ListExternalSAMLIdPCertificates. | Consulta os certificados de assinatura SAML. |
| RemoveExternalSAMLIdPCertificate | RemoveExternalSAMLIdPCertificate. | Remove um certificado de assinatura Security Assertion Markup Language (SAML). |
Gerenciamento de configurações de acesso
|
API |
Título |
Descrição |
| CreateAccessConfiguration | Create an access configuration. | Cria uma configuração de acesso. |
| ListAccessConfigurations | Consultar configurações de acesso. | Consulta a lista de configurações de acesso. |
| GetAccessConfiguration | Consultar informações da configuração de acesso. | Consulta as informações sobre uma configuração de acesso. |
| UpdateAccessConfiguration | UpdateAccessConfiguration. | Modifica informações sobre uma configuração de acesso. |
| DeleteAccessConfiguration | Excluir uma configuração de acesso | Exclui uma configuração de acesso. |
| AddPermissionPolicyToAccessConfiguration | Adicionar uma política de acesso a uma configuração de acesso | Adiciona uma política de acesso 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. |
| ListPermissionPoliciesInAccessConfiguration | ListPermissionPoliciesInAccessConfiguration. | Consulta as políticas criadas para uma configuração de acesso. |
Gerenciamento de autorização de múltiplas contas
|
API |
Título |
Descrição |
| ProvisionAccessConfiguration | Implantação de uma configuração de acesso em uma conta em um diretório de recursos | Invoca o ProvisionAccessConfiguration para executar o provisionamento e a implantação da configuração de acesso para uma conta em um diretório de recursos. |
| DeprovisionAccessConfiguration | Remoção do provisionamento de uma configuração de acesso de uma conta em um diretório de recursos | Remove o provisionamento de uma configuração de acesso de uma conta em um diretório de recursos. |
| ListAccessConfigurationProvisionings | Listar provisionamentos de configurações de acesso | Consulta os provisionamentos de configurações de acesso. |
| CreateAccessAssignment | Conceder acesso a uma conta em um diretório de recursos | Configura as definições para os usuários ou grupos com permissão para acessar uma conta em um diretório de recursos e as permissões de acesso correspondentes (configurações de acesso). |
| ListAccessAssignments | Listar atribuições de acesso | Consulta as atribuições de acesso. |
| DeleteAccessAssignment | Remoção da autorização de uma conta em um diretório de recursos | Remove a autorização de uma conta em um diretório de recursos. |
Gerenciamento da sincronização de usuários do RAM
|
API |
Título |
Descrição |
| CreateUserProvisioning | Criação de uma sincronização de usuário do Resource Access Management (RAM) | Invoca CreateUserProvisioning para criar uma sincronização de usuário do Resource Access Management (RAM). |
| GetUserProvisioning | GetUserProvisioning. | Consulta 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 | Exclusão de uma sincronização de usuário do Resource Access Management (RAM) | Invoca DeleteUserProvisioning para excluir uma sincronização de usuário do Resource Access Management (RAM). |
| UpdateUserProvisioningConfiguration | UpdateUserProvisioningConfiguration. | Modifica as configurações globais do provisionamento de usuários do Resource Access Management (RAM). |
| GetUserProvisioningConfiguration | GetUserProvisioningConfiguration. | Consulta as configurações globais de 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). |
| GetUserProvisioningEvent | GetUserProvisioningEvent. | Consulta as informações sobre um provisionamento de usuário do Resource Access Management (RAM). |
| DeleteUserProvisioningEvent | Exclui um evento de sincronização de usuário do Resource Access Management (RAM) | Invoca DeleteUserProvisioningEvent para excluir um evento de sincronização de usuário do Resource Access Management (RAM) que falhou na execução. |
| RetryUserProvisioningEvent | RetryUserProvisioningEvent. | Tenta novamente um evento de provisionamento de usuário do Resource Access Management (RAM). |
| GetUserProvisioningStatistics | GetUserProvisioningStatistics. | Consulta as estatísticas de 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. |
Outros (não mantidos)
|
API |
Título |
Descrição |
| SetMFAAuthenticationStatus | Definir status de autenticação MFA. | Ativa ou desativa a autenticação multifator (MFA) para usuários em um diretório. |
| GetMFAAuthenticationStatus | GetMFAAuthenticationStatus. | Verifica se a autenticação multifator (MFA) está ativada para os usuários. |
Outros
|
API |
Título |
Descrição |
| CreateDirectory | Cria um diretório | Cria um diretório. |
| CreateGroup | Criar um grupo de usuários | Cria um grupo de usuários. |
| CreateUser | Criar um usuário. | Cria um usuário chamando CreateUser. |
| DeleteDirectory | Excluir um diretório | Exclui um diretório. |
| DeleteGroup | Excluir um grupo especificado | Exclui um grupo especificado. |
| DeleteUser | Excluir um usuário | Exclui um usuário. |
| GetAttributePassingSetting | Consulta das configurações de passagem de atributos. | Consulta as configurações de passagem de atributos de um diretório especificado para obter a configuração atual do modo de passagem do SourceIdentity. |
| GetGroup | GetGroup. | Consulta as informações de um grupo. |
| GetTask | Consulta de detalhes de tarefa assíncrona | Consulta os detalhes de uma tarefa assíncrona. |
| GetTaskStatus | GetTaskStatus. | Consulta o status de uma tarefa assíncrona. |
| GetUser | Consultar informações do usuário. | Consulta as informações de um usuário especificado. |
| ListGroups | ListGroups. | Consulta os grupos. |
| ListTagResources | Relações entre recursos e tags | Consulta as relações entre recursos e tags. |
| ListTasks | Consulta de tarefas assíncronas | Consulta uma lista de tarefas assíncronas. |
| ListUsers | Consultar lista de usuários. | Consulta uma lista de usuários. |
| ResetUserPassword | Redefinir a senha de um usuário | Redefine a senha de um usuário. |
| TagResources | Adicionar tags a recursos | Adiciona tags a recursos. |
| UntagResources | Remover tags de recursos | Remove as tags dos recursos. |
| UpdateAttributePassingSetting | Atualizar configurações de passagem de atributos. | Atualiza as configurações de passagem de atributos de um diretório especificado, permitindo que você defina o modo de passagem do SourceIdentity como IdP, UserName ou Disabled. |
| UpdateGroup | UpdateGroup. | Modifica as informações sobre um grupo. |
| UpdateUser | UpdateUser. | Modifica as informações de um usuário. |