Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Actualización más reciente 2023-01-31 GMT+08:00

Realización de Autenticación

Descripción

Esta API se utiliza para autenticar la cuenta y la contraseña de Huawei Cloud Meeting. Después de que la autenticación es exitosa, se genera un token de acceso.

SLA

Tasa de éxito de solicitudes: > 99.99%

Retraso de la petición TP99: 135 ms

  • Cuando clientType se establece en 72, se pueden crear hasta 64 tokens para cada cuenta. Si se han creado 64 tokens usando una cuenta y los tokens son válidos, crear un nuevo token usando la misma cuenta invalidará el primer token entre los primeros 64 tokens.
  • Cuando clientType no se establece en 72, solo se puede crear un token para cada cuenta.
  • Un token es válido durante 12 a 24 horas.

Depuración

Puede depurar esta API en API Explorer.

Prototipo

Tabla 1 Prototipo

Método de solicitud

POST

Dirección de solicitud

/v1/usg/acs/auth/account

Protocolo de transporte

HTTPS

Parámetros de solicitud

Tabla 2 Parámetros

Parámetro

Obligatorio

Tipo

Localización

Descripción

Autorización

String

Header

Token de autorización, que lleva la cuenta de usuario y la contraseña. La cuenta y la contraseña deben ser transcoded using Base64.

  • Regla

Basic Base64(username: password)

  • Ejemplo

Basic eWMyOjE5OTUwwWWM=

NOTA:

La contraseña contiene de 6 a 32 caracteres.

Content-Type

String

Header

Formato de los medios de comunicación del cuerpo.

  • Ejemplo: application/json; charset=UTF-8

X-Request-ID

No

String

Header

ID de solicitud, que se utiliza para el seguimiento y la localización de fallos. Se recomienda utilizar un UUID. Si este parámetro no se incluye, se genera automáticamente un ID de solicitud.

Accept-Language

No

String

Header

Idioma. Valores: zh-CN para chino (predeterminado) y en-US para inglés.

HA2

No

String

Body

Información de código de verificación, que es devuelta por el servidor en escenarios de código de verificación.

account

String

Body

Cuenta de usuario (cuenta de Huawei Cloud Meeting).

  • Ejemplo: zhangsan@huawei

Debe solicitar una cuenta por adelantado. Para obtener más información, consulte Proceso de desarrollo.

NOTA:
  • La cuenta debe contener de 1 a 255 caracteres.

clientType

Integer

Body

Tipo del cliente de inicio de sesión.

  • 72: Llamada a la API.

createTokenType

No

Integer

Body

Si se genera un token. El valor predeterminado es 0.

  • 0: Se genera un token para la autenticación de inicio de sesión.
  • 1: No se genera ningún token.

Códigos de estado

Tabla 3 Códigos de estado

Código de estado de HTTP

Descripción

200

Operación exitosa.

400

Parámetros inválidos.

401

Acceso denegado.

412

La cuenta se ha deshabilitado.

423

La cuenta se ha bloqueado.

500

Excepción del servidor.

Parámetros de respuesta

Tabla 4 Parámetros de respuesta

Parámetro

Tipo

Descripción

accessToken

String

Token.

clientType

Integer

Tipo de cuenta utilizada para iniciar sesión.

  • 72: Llamada a la API.

createTime

Long

Marca de tiempo cuando se crea el token, en milisegundos.

daysPwdAvailable

Integer

Período de validez de contraseña.

expireTime

Long

Marca de tiempo cuando el token caduca, en segundos.

firstLogin

Boolean

Si el inicio de sesión es el primer inicio de sesión.

NOTA:

Si inicia sesión en el sistema por primera vez, el sistema le pedirá que cambie la contraseña inicial.

Valor predeterminado: false.

proxyToken

ProxyTokenDTO object

Información de autenticación de proxy.

pwdExpired

Boolean

Si la contraseña ha caducado.

Valor predeterminado: false.

refreshCreateTime

Long

Marca de tiempo cuando se crea un token de actualización, en milisegundos.

refreshExpireTime

Long

Marca de tiempo cuando el token de actualización expira, en segundos.

refreshToken

String

Actualizar el token.

refreshValidPeriod

Long

Período de validez del token de actualización, en segundos.

tokenIp

String

Dirección IP del usuario de inicio de sesión.

tokenType

Integer

Token type.

  • 0: token de acceso de usuario.
  • 1: token de control de reunión.
  • 2: token de un solo uso.

user

UserInfo object

Detalles de autenticación de usuario.

validPeriod

Long

Período de validez del token, en segundos.

forceLoginInd

Integer

Si el inicio de sesión apropiativo está habilitado.

  • 0: deshabilitado.
  • 1: habilitado. (Este valor no se proporciona.)

delayDelete

Boolean

Si se retrasa la eliminación del token.

Tabla 5 Estructura de datos de ProxyTokenDTO

Parámetro

Tipo

Descripción

accessToken

String

Token corto del servidor proxy, una cadena.

enableRerouting

Boolean

Si se debe habilitar la ruta secundaria.

longAccessToken

String

Token largo del servidor proxy, una cadena.

middleEndInnerUrl

String

Dirección de red interna del extremo medio.

middleEndUrl

String

URL del extremo medio.

validPeriod

Long

Período de validez del token, en segundos.

Tabla 6 Estructura de datos de UserInfo

Parámetro

Tipo

Descripción

adminType

Integer

Tipo de administrador.

  • 0: administrador predeterminado.
  • 1: administrador común.
  • 2: no administrador, es decir, miembro común de la empresa. Este valor es válido solo cuando userType se establece en 2.

appId

String

ID de la aplicación.

cloudUserId

String

ID de cuenta de Huawei Cloud.

companyDomain

String

Nombre de dominio de empresa.

companyId

String

ID de la empresa a la que pertenece el usuario.

corpType

Integer

Edición del paquete de servicio de Huawei Cloud Meeting.

  • 0: edición empresarial.
  • 5: edición gratuita.
  • 6: edición profesional.

freeUser

Boolean

Si el usuario de inicio de sesión es un usuario de prueba gratuita.

grayUser

Boolean

Si el usuario de inicio de sesión es un usuario gris.

headPictureUrl

String

Enlace de imagen de perfil.

isBindPhone

Boolean

Si un número de teléfono móvil está vinculado a la cuenta.

name

String

Nombre del usuario.

nameEn

String

Nombre en inglés del usuario.

numberHA1

String

HA1 correspondiente al número SIP.

alias1

String

Alias del usuario.

paidAccount

String

Cuenta de acceso de terminal de pago, que se utiliza para iniciar sesión en un TV.

paidPassword

String

Contraseña de la cuenta de acceso de terminal de pago, que se utiliza para iniciar sesión en un TV.

password

String

Contraseña de una cuenta de acceso de terminal gratuita, que se utiliza para iniciar sesión en un TV.

realm

String

Autenticación local:

serviceAccount

String

Número SIP asociado con el usuario.

spId

String

ID del SP que administra la empresa a la que pertenece el usuario.

status

Integer

Estado del usuario.

  • 0: normal.
  • 1: deshabilitado.

thirdAccount

String

Cuenta de usuario de terceros.

tr069Account

String

Cuenta TR069.

ucloginAccount

String

Cuenta de Huawei Cloud Meeting.

userId

String

UUID de un usuario.

userType

Integer

Tipo de usuario.

  • 1: administrador de SP.
  • 2: usuario de empresa.
  • 3: usuario libre.
  • 10: usuario del dispositivo empresarial.
  • 11: usuario anónimo.
  • 12: usuario de Smart TV.
  • 13: usuario de IdeaHub.
  • 14: usuario de pizarra blanca.

visionAccount

String

ID de Smart TV.

weLinkUser

Boolean

Si el usuario es un usuario de WeLink.

Ejemplo de solicitud

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
}

Ejemplo de respuesta

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 error

Si se devuelve un código de error que comienza con MMC o USG cuando utiliza esta API, corrija el error siguiendo las instrucciones proporcionadas enCentro de errores de la API de Huawei Cloud.

Ejemplo 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'