Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Meeting/ Referência de API do servidor/ Autenticação de logon/ APIs/ Execução de autenticação

Atualizado em 2023-08-02 GMT+08:00

Ver PDF

Execução de autenticação

Descrição

Esta API é utilizada para autenticar a conta e a palavra-passe do Huawei Cloud Meeting. Depois que a autenticação é bem-sucedida, um token de acesso é gerado.

SLA

Taxa de sucesso de solicitação: > 99,99%

Atraso na solicitação TP99: 135 ms

Quando clientType é definido como 72, até 64 tokens podem ser criados para cada conta. Se 64 tokens foram criados usando uma conta e os tokens são válidos, criar um novo token usando a mesma conta invalidará o primeiro token entre os primeiros 64 tokens.
Quando clientType não é definido como 72, apenas um token pode ser criado para cada conta.
Um token é válido por 12 a 24 horas.

Depuração

Você pode depurar essa API no API Explorer.

Protótipo

**Tabela 1** Protótipo
Método de solicitação	POST
Endereço de solicitação	/v1/usg/acs/auth/account
Protocolo de transporte	HTTPS

Parâmetros de solicitação

**Tabela 2** Parâmetros
Parâmetro	Obrigatório	Tipo	Localização	Descrição
Authorization	Sim	String	Cabeçalho	Token de autorização, que carrega a conta de usuário e senha. A conta e a senha precisam ser transcodificadas usando Base64. Regra Basic Base64(nome de usuário:senha) Exemplo Basic eWMyOjE5OTUwwWWM= NOTA: A senha contém de 6 a 32 caracteres.
Content-Type	Sim	String	Cabeçalho	Formato de mídia do corpo. Exemplo: application/json;charset=UTF-8
X-Request-ID	Não	String	Cabeçalho	ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente.
Accept-Language	Não	String	Cabeçalho	Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês.
HA2	Não	String	Corpo	Informações de código de verificação, que são retornadas pelo servidor em cenários de código de verificação.
account	Sim	String	Corpo	Conta de usuário (conta do Huawei Cloud Meeting). Exemplo: zhangsan@huawei Você deve solicitar uma conta com antecedência. Para obter detalhes, consulte Processo de desenvolvimento. NOTA: A conta deve conter de 1 a 255 caracteres.
clientType	Sim	Integer	Corpo	Tipo do cliente de logon. 72: chamada de API.
createTokenType	Não	Integer	Corpo	Se gerar um token. O valor padrão é 0. 0: um token é gerado para autenticação de logon. 1: nenhum token é gerado.

Códigos de status

**Tabela 3** Códigos de status
Código de status HTTP	Descrição
200	Operação bem-sucedida.
400	Parâmetros inválidos.
401	Acesso negado.
412	A conta foi desativada.
423	A conta foi bloqueada.
500	Exceção do servidor.

Parâmetros de resposta

**Tabela 4** Parâmetros de resposta
Parâmetro	Tipo	Descrição
accessToken	String	Token.
clientType	Integer	Tipo da conta usada para fazer logon. 72: chamada de API.
createTime	Long	Carimbo de data/hora quando o token é criado, em milissegundos.
daysPwdAvailable	Integer	Período de validade de senha.
expireTime	Long	Carimbo de data/hora quando o token expira, em segundos.
firstLogin	Boolean	Se o logon é o primeiro logon. NOTA: Se você fizer logon no sistema pela primeira vez, o sistema solicitará que você altere a senha inicial. Valor padrão: false.
proxyToken	ProxyTokenDTO object	Informações de autenticação do proxy.
pwdExpired	Boolean	Se a senha expirou. Valor padrão: false.
refreshCreateTime	Long	Carimbo de data/hora quando um token de atualização é criado, em milissegundos.
refreshExpireTime	Long	Carimbo de data/hora quando o token de atualização expira, em segundos.
refreshToken	String	Token de atualização.
refreshValidPeriod	Long	Período de validade do token de atualização, em segundos.
tokenIp	String	Endereço IP do usuário de logon.
tokenType	Integer	Tipo de token. 0: token de acesso do usuário. 1: token de controle de reunião. 2: token único.
user	UserInfo object	Detalhes de autenticação do usuário.
validPeriod	Long	Período de validade do token, em segundos.
forceLoginInd	Integer	Se o logon preventivo está ativado. 0: desativado. 1: ativado. (Este valor não é fornecido.)
delayDelete	Boolean	Se a exclusão do token está atrasada.

**Tabela 5** Estrutura de dados ProxyTokenDTO
Parâmetro	Tipo	Descrição
accessToken	String	Token curto do servidor proxy, uma cadeia.
enableRerouting	Boolean	Se ativar a rota secundária.
longAccessToken	String	Token longo do servidor proxy, uma cadeia.
middleEndInnerUrl	String	Endereço de rede interna da extremidade intermediária.
middleEndUrl	String	URL da extremidade do meio.
validPeriod	Long	Período de validade do token, em segundos.

**Tabela 6** Estrutura de dados UserInfo
Parâmetro	Tipo	Descrição
adminType	Integer	Tipo de administrador. 0: administrador padrão. 1: administrador comum. 2: não-administrador, ou seja, membro comum da empresa. Esse valor é válido somente quando userType é definido como 2.
appId	String	ID de aplicação.
cloudUserId	String	ID da conta da Huawei Cloud.
companyDomain	String	Nome de domínio empresarial.
companyId	String	ID da empresa à qual o usuário pertence.
corpType	Integer	Edição do pacote de serviços do Huawei Cloud Meeting. 0: edição empresarial. 5: edição grátis. 6: edição profissional.
freeUser	Boolean	Se o usuário de logon é um usuário de avaliação gratuita.
grayUser	Boolean	Se o usuário de logon é um usuário cinza.
headPictureUrl	String	Link da imagem do perfil.
isBindPhone	Boolean	Se um número de celular está vinculado à conta.
name	String	Nome do usuário.
nameEn	String	Nome em inglês do usuário.
numberHA1	String	HA1 correspondente ao número SIP.
alias1	String	Alias do usuário.
paidAccount	String	Conta de acesso ao terminal pago, que é usada para fazer logon em uma TV inteligente.
paidPassword	String	Senha da conta de acesso ao terminal pago, que é usada para fazer logon em uma TV inteligente.
password	String	Senha de uma conta de acesso de terminal gratuito, que é usada para fazer logon em uma TV inteligente.
realm	String	Autenticação local.
serviceAccount	String	Número SIP associado ao usuário.
spId	String	ID do SP que gerencia a empresa à qual o usuário pertence.
status	Integer	Estado do usuário. 0: normal. 1: desativado.
thirdAccount	String	Conta de usuário de terceiros.
tr069Account	String	Conta TR069.
ucloginAccount	String	Conta do Huawei Cloud Meeting.
userId	String	UUID de um usuário.
userType	Integer	Tipo de usuário. 1: administrador SP. 2: usuário empresarial. 3: usuário gratuito. 10: usuário do dispositivo empresarial. 11: usuário anônimo. 12: usuário da TV inteligente. 13: usuário do IdeaHub. 14: usuário do quadro branco.
visionAccount	String	ID da TV inteligente.
weLinkUser	Boolean	Se o usuário é um usuário do WeLink.

Exemplo de solicitação

POST /v1/usg/acs/auth/account
Connection: keep-alive
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
Content-Length: 94
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "account": "user01",
    "clientType": 72,
    "createTokenType": 0
}

Exemplo de resposta

HTTP/1.1 200 OK
Date: Tue, 17 Dec 2019 09:32:47 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 591
Connection: keep-alive
X-Request-Id: f90fbd8714328398fcbedddde0f1303c

{
    "accessToken": "stbl2oG5GKrcNirGSOVLEAm3dSaOiygp3E1v",
    "clientType": 72,
    "createTime": 1599102826754,
    "daysPwdAvailable": -18172,
    "delayDelete": false,
    "expireTime": 1577979513,
    "firstLogin": true,
    "forceLoginInd": null,
    "proxyToken": null,
    "pwdExpired": false,
    "refreshCreateTime": 1599102826754,
    "refreshExpireTime": 1601694826,
    "refreshToken": "stbYaza5VVRr3IGuLSs6ZvF0lMHHvGO0tQ0f",
    "refreshValidPeriod": 2592000,
    "tokenIp": "10.8.0.90",
    "tokenType": 0,
    "user": {
        "adminType": 2,
        "alias1": null,
        "appId": null,
        "cloudUserId": "76aaaba8a12f4c0a8a43192ac1fg42ac4",
        "companyDomain": null,
        "companyId": "f5968fc4f9c14d50905e8e66672dabc6",
        "corpType": 0,
        "freeUser": false,
        "grayUser": false,
        "headPictureUrl": null,
        "isBindPhone": null,
        "name": "xxxx_name",
        "nameEn": null,
        "numberHA1": "1ead5e5ce44849bc2718d5c....",
        "paidAccount": null,
        "paidPassword": null,
        "password": null,
        "realm": "huaweicloud.com",
        "serviceAccount": "sip:xxxx@huaweicloud.com",
        "spId": "666bd8558e4646e1a7e1a0c99cf898e8",
        "status": 0,
        "thirdAccount": "62fe180o133fd...",
        "tr069Account": "X3M537A6IX4SC...",
        "ucloginAccount": "z8b2vo875ioh54r29ad5e3552vb3gm8np2j167...",
        "userId": "0d5202707123429d876....",
        "userType": 2,
        "visionAccount": null,
        "weLinkUser": false
    },
    "validPeriod": 84616
}

Códigos de erro

Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas na Centro de erros da API da Huawei Cloud.

Exemplo de comando cURL

curl -k -i -H 'content-type: application/json' -X POST  -H 'Authorization:Basic dGVzdDp0ZXN0' -d '{"account": "user01","clientType": 72,"createTokenType": 0}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/auth/account'

Tópico principal: APIs

Tópico anterior: Autenticação de um ID de aplicação

Próximo tópico: Atualização de um token