GetAuthCode - : Central de Documentação do Alibaba Cloud

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecd:GetAuthCode

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ExternalUserId	string	Não	O ID externo do usuário. Este ID é definido pelo chamador e deve ser único dentro de uma conta Alibaba Cloud. Este parâmetro e EndUserId não podem estar ambos vazios.	alice
EndUserId	string	Não	O nome de usuário da conta de conveniência do China Desktop Service (China Desktop Service). O nome de usuário deve ser único dentro de uma conta Alibaba Cloud. Este parâmetro e ExternalUserId não podem estar ambos vazios.	alice
Policy	string	Não	A política de acesso que restringe as permissões de acesso do código de autorização. Se este parâmetro for deixado vazio, nenhuma restrição será aplicada. Sintaxe: `{ "Version": "1", "Resource": { "Type": "<Tipo de recurso>", "Id": "<ID do recurso>" } }` Valores válidos de : AppInstanceGroup: grupo de entrega. Você pode chamar a operação ListAppInstanceGroup para obter o ID. AppInstance: instância de aplicação (campo dedicado). App: aplicação. Você pode chamar a operação ListAppInstanceGroup para obter o ID.	{ "Version": "1", "Resource": { "Type": "AppInstanceGroup", "Id": "aig-9ciijz60n4xsv****" } }
AutoCreateUser	boolean	Não	Especifica se um EndUserId deve ser criado sincronamente com base no ExternalUserId. Este parâmetro só tem efeito quando EndUserId está vazio. Valores válidos: true : Criar sincronamente. false : Não criar sincronamente (padrão)	false
TokenType	string	Não
AccountType	string	Não
AdDomain	string	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
AuthModel	object	As informações do código de autorização.
AuthCode	string	O código de autorização. O código de autorização é válido por 3 minutos e pode ser usado apenas uma vez, independentemente de a verificação ter sucesso ou falhar. Se vários códigos de autorização forem gerados para um usuário, apenas o último código de autorização gerado será válido.	acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********
EndUserId	string	O nome de usuário da conta de conveniência do China Desktop Service.	alice
ExpireTime	string	O horário de expiração do código de autorização em UTC, seguindo o padrão ISO 8601.	2015-01-23T12:33:18Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AuthModel": {
    "AuthCode": "acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********",
    "EndUserId": "alice",
    "ExpireTime": "2015-01-23T12:33:18Z"
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.