Visão geral da API - Identity as a Service: Central de Documentação do Alibaba Cloud

Padrões de API e SDKs predefinidos multilíngues

A OpenAPI deste produto (Eiam-developerapi/2022-02-25) utiliza o estilo de assinatura ROA. 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.

API de token de autenticação

API	Título	Descrição
ObtainJwtAuthenticationToken	ObtainJwtAuthenticationToken.	Obtém um token de autenticação JWT.
FetchOAuthAuthenticationToken	FetchOAuthAuthenticationToken.	Obtém um token de autenticação OAuth válido.
GenerateJwtAuthenticationToken	GenerateJwtAuthenticationToken.	Gera um token de autenticação JSON Web Token (JWT).
ListAuthenticationTokens	ListAuthenticationTokens.	Lista os tokens de autenticação.
ObtainJwtAuthenticationTokenByDerivedShortToken	ObtainJwtAuthenticationTokenByDerivedShortToken.	Obtém um token de autenticação JWT usando um token curto derivado.
ReinstateAuthenticationToken	ReinstateAuthenticationToken.	Restabelece um token de autenticação.
ReinstateAuthenticationTokenByConsumer	ReinstateAuthenticationTokenByConsumer.	Reinstala um token de autenticação para um consumidor.
RevokeAuthenticationToken	RevokeAuthenticationToken.	Revoga um token de autenticação.
RevokeAuthenticationTokenByConsumer	RevokeAuthenticationTokenByConsumer.	Revoga um token de autenticação para um consumidor.
ValidateAuthenticationToken	ValidateAuthenticationToken.	Valida um token de autenticação.

API de credenciais

API	Título	Descrição
CreateUserExclusiveCredential	CreateUserExclusiveCredential.	Cria uma credencial exclusiva de usuário.
ObtainCredential	ObtainCredential.	Obtém o texto em claro de um segredo.

API de credenciais de acesso de função da nuvem

API	Título	Descrição
ObtainCloudAccountRoleAccessCredential	ObtainCloudAccountRoleAccessCredential.	Obtém credenciais de acesso temporárias para uma CloudAccountRole.

API OIDC

API	Título	Descrição
GenerateTokenByAuthorizationServer	GenerateTokenByAuthorizationServer.	O endpoint de token para um servidor de autorização em nível de instância.
GenerateToken	GenerateToken.	Gera um token de acesso para um aplicativo em uma instância IDaaS especificada com base nas informações de credenciais.
GenerateDeviceCode	GenerateDeviceCode.	Gera um código de dispositivo.
GetUserInfo	GetUserInfo.	Obtém as informações de um usuário usando o token do usuário.
RevokeToken	RevokeToken.	Revoga um token de acesso ou um token de atualização.

API de escopo de autorização

API	Título	Descrição
GetApplicationProvisioningScope	GetApplicationProvisioningScope.	Obtém o escopo de sincronização de um aplicativo em uma instância específica.

API de gerenciamento de organizações

API	Título	Descrição
CreateOrganizationalUnit	CreateOrganizationalUnit.	Cria uma unidade organizacional.
PatchOrganizationalUnit	PatchOrganizationalUnit.	Modifica uma unidade organizacional do EIAM.
GetOrganizationalUnit	GetOrganizationalUnit.	Obtém as informações sobre uma unidade organizacional.
DeleteOrganizationalUnit	DeleteOrganizationalUnit.	Exclui uma unidade organizacional.
ListOrganizationalUnits	ListOrganizationalUnits.	Realiza uma consulta paginada para recuperar informações de organizações do EIAM.
ListOrganizationalUnitParentIds	ListOrganizationalUnitParentIds.	Obtém as informações sobre todas as unidades organizacionais pai de uma unidade organizacional.
GetOrganizationalUnitIdByExternalId	GetOrganizationalUnitIdByExternalId.	Obtém o ID de uma unidade organizacional com base no ID externo.

API de gerenciamento de contas

API	Título	Descrição
CreateUser	CreateUser.	Cria uma nova conta EIAM em uma organização especificada.
PatchUser	PatchUser.	Modifica uma conta do Employee Identity and Access Management (EIAM).
GetUser	GetUser.	Obtém os detalhes de uma conta do Employee Identity and Access Management (EIAM).
UpdateUserPassword	UpdateUserPassword.	Atualiza a senha de uma conta EIAM especificada.
DeleteUser	DeleteUser.	Exclui uma conta do Employee Identity and Access Management (EIAM).
ListUsers	ListUsers.	Realiza uma consulta paginada das informações de contas do EIAM.
EnableUser	EnableUser.	Ativa uma conta do Employee Identity and Access Management (EIAM).
DisableUser	DisableUser.	Desativa uma conta do Employee Identity and Access Management (EIAM).
GetUserIdByEmail	GetUserIdByEmail.	Consulta o ID de uma conta do Employee Identity and Access Management (EIAM) por endereço de e-mail.
GetUserIdByPhoneNumber	GetUserIdByPhoneNumber.	Consulta o ID de uma conta do Employee Identity and Access Management (EIAM) com base no número de celular.
GetUserIdByUserExternalId	GetUserIdByUserExternalId.	Consulta o ID de uma conta do Employee Identity and Access Management (EIAM) com base no ID externo.
GetUserIdByUsername	GetUserIdByUsername.	Consulta o ID de uma conta do Employee Identity and Access Management (EIAM) com base no nome de usuário.
SetUserPrimaryOrganizationalUnit	SetUserPrimaryOrganizationalUnit.	Define a organização principal para uma conta EIAM. Esta operação remove a conta da organização principal antiga e a adiciona à nova.
AddUserToOrganizationalUnits	AddUserToOrganizationalUnits.	Adiciona uma conta EIAM a uma ou mais organizações EIAM. Essas organizações servem como organizações subordinadas para a conta. Se a conta já for membro de uma organização especificada, nenhuma atualização será realizada.
RemoveUserFromOrganizationalUnits	RemoveUserFromOrganizationalUnits.	Remove uma conta EIAM de uma ou mais unidades organizacionais EIAM. A operação é bem-sucedida mesmo que a conta não esteja nas unidades organizacionais especificadas.
ListGroupsForUser	ListGroupsForUser.	Lista os grupos dos quais um usuário EIAM é membro.

API de gerenciamento de grupos de contas

API	Título	Descrição
GetGroup	GetGroup.	Obtém os detalhes de um grupo.
CreateGroup	CreateGroup.	Cria um grupo.
PatchGroup	PatchGroup.	Modifica as informações de um grupo do Employee Identity and Access Management (EIAM).
DeleteGroup	Excluir um grupo.	Exclui um grupo.
ListGroups	ListGroups.	Obtém informações paginadas sobre grupos do Employee Identity and Access Management (EIAM).
AddUsersToGroup	AddUsersToGroup.	Adiciona várias contas do Employee Identity and Access Management (EIAM) a um grupo do EIAM. Se as contas já estiverem adicionadas ao grupo especificado, nenhuma atualização é realizada.
ListUsersForGroup	ListUsersForGroup.	Consulta contas em um grupo do Employee Identity and Access Management (EIAM).

Others

API	Título	Descrição
RemoveUsersFromGroup	RemoveUsersFromGroup.	Remove várias contas do Employee Identity and Access Management (EIAM) de um grupo do EIAM. Se uma conta não pertencer ao grupo, a remoção é bem-sucedida por padrão.