为了更安全的网络访问,请务必使用TLS1.2协议及规定内的加密套件。若使用协议是TLS1.0、TLS1.1或规定外的加密套件,可能无法正常访问华为账号服务。
关于TLS1.2协议及规定内加密套件的信息,可以点击这里进行详细了解:TLS协议及加密套件。
第三方应用通过ID Token方式进行华为账号登录授权,要解析出用户的ID Token,需要先对ID Token的有效性进行验证,如果本地验证失败,可调用此接口向华为服务器发送验证请求进行调试,验证ID Token的有效性。
如果ID Token是直接调用获取用户级凭证的接口获取的,则不需要验证ID Token的有效性。
承载协议: HTTPS POST
接口方向: 开发者服务器->华为账号服务器
接口URL: https://oauth-login.cloud.huawei.com/oauth2/v3/tokeninfo
数据格式:
请求消息:Content-Type: application/x-www-form-urlencoded
响应消息:Content-Type: application/json
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 取值为:application/x-www-form-urlencoded。 说明: Request Body传参,请务必遵循此请求头格式,否则可能导致请求失败,具体传参方式可参考示例代码。 |
请通过POST方式调用,示例如下:
POST /oauth2/v3/tokeninfo HTTP/1.1 Host:oauth-login.cloud.huawei.com Content-Type: application/x-www-form-urlencoded id_token=<id_token>
调用成功时,响应消息体返回如下:
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| typ | 是 | String | ID Token的格式,固定“JWT”。 |
| alg | 是 | String | ID Token的签名算法。 - PS256 - RS256 |
| kid | 是 | String | 验证签名所用公私密钥对的id,长度最大256。 |
调用失败时,响应消息体返回如下:
其中部分字段与生成id_token的scope有关,如下为各scope对应字段说明:
scope包含权限项openid时,解析的字段映射表如下:
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| iss | 是 | String | 固定值:https://accounts.huawei.com。 |
| sub | 是 | String | 用户的UnionID。具体格式要求请参考OpenID和UnionID的格式说明。 |
| aud | 是 | String | 接收ID Token的Client ID。 |
| exp | 是 | Long | ID Token的过期时间戳(10位)。 |
| iat | 是 | Long | ID Token的生成时间戳(10位)。 |
| at_hash | 是 | String | Access Token的哈希值。 |
| azp | 是 | String | 生成ID Token的Client ID。 |
| openid | 是 | String | 用户OpenID。具体格式要求请参考OpenID和UnionID的格式说明。 |
| nonce | 否 | String | 防重放攻击随机值。详情请参考LoginWithHuaweiIDRequest或AuthorizationWithHuaweiIDRequest的nonce字段说明。 |
scope包含权限项profile时,解析的字段映射表如下:
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| picture | 否 | String | 用户头像图片链接。 说明: 当用户更新头像后,原头像链接会立即失效。为确保头像正常显示,建议先将头像下载保存后再使用,避免因用户头像链接失效而影响业务流程。 |
| display_name | 否 | String | 华为账号对应的昵称,没有昵称则取匿名化的邮箱或手机号。 |
| nickname | 否 | String | 华为账号对应的昵称。 |
scope包含权限项quickLoginAnonymousPhone时,解析的字段映射表如下:
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| anonymized_login_mobile_number | 否 | String | 匿名化的华为账号绑定手机号码,详见华为账号一键登录(获取手机号和UnionID/OpenID)。 |
scope包含权限项email时,解析的字段映射表如下:
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| email_verified | 否 | Boolean | 用户邮箱是否已验证。 - true:是 - false:否 由于Email不是华为账号的必填项,响应中可能没有这个属性。 |
| 否 | String | 用户邮箱地址,由于Email不是华为账号的必填项,响应中可能没有这个属性。 |
HTTP/1.1 200 OK
Content-Type: application/json
{
"at_hash": "Dx5WUwU*****L-SKuAvWUg",
"sub": "AQAxrB1HNA*****n-IfWRSUVq2M7xU",
"kid": "6a2880c5d6a88c*****88eb680e05197d5bebd*****7b71757fc1b9530809ca",
"iss": "https://accounts.huawei.com",
"typ": "JWT",
"display_name": "Jack",
"nickname": "Jack",
"aud": "30*****33",
"azp": "30*****33",
"exp": 1563823909,
"iat": 1563820309,
"alg": "PS256",
"nonce": "default",
"openid": "AQAxrBzThFv*****lv9tV_4rMCc"
} HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"sub_error": 14004,
"error_description": "jwk not found error",
"error": 1400
} Java示例代码如下,运行前需要进行示例代码环境配置(请将此示例代码与工具类CallUtils放于同一路径下,如不在同一路径,请手动添加import)
import com.alibaba.fastjson2.JSONObject;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.message.BasicNameValuePair;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* 验证ID Token有效性
*/
public class IDTokenAPIDemo {
public static void main(String[] args) throws IOException {
// 验证ID Token有效性的接口URL
String url = "https://oauth-login.cloud.huawei.com/oauth2/v3/tokeninfo";
// 替换为获取到的ID Token
String idToken = "<ID Token>";
JSONObject result = getDetailByIDToken(url, idToken);
// 解析获取kid
String kid = result.getString("kid");
// 解析获取typ
String typ = result.getString("typ");
// 解析获取alg
String alg = result.getString("alg");
// 解析获取iss
String iss = result.getString("iss");
// 解析获取sub
String sub = result.getString("sub");
// 解析获取aud
String aud = result.getString("aud");
// 解析获取exp
Long exp = result.getLong("exp");
// 解析获取iat
Long iat = result.getLong("iat");
// 解析获取at_hash
String atHash = result.getString("at_hash");
// 解析获取azp
String azp = result.getString("azp");
// 解析获取openid
String openid = result.getString("openid");
// 解析获取nonce
String nonce = result.getString("nonce");
}
private static JSONObject getDetailByIDToken(String url, String idToken) throws IOException {
HttpPost httpPost = new HttpPost(url);
List<NameValuePair> request = new ArrayList<>();
request.add(new BasicNameValuePair("id_token", idToken));
httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded");
httpPost.setEntity(new UrlEncodedFormEntity(request));
return CallUtils.toJsonObject(CallUtils.remoteCallOAuth(httpPost));
}
} | HTTP响应码 | 描述 | 解决方法 |
|---|---|---|
| 200 | 成功。 | - |
| 400 | 参数错误。 | 请根据业务响应主错误码以及业务响应子错误码进一步排查问题。 |
| 403 | 无权限访问。 | 通常是调用方网络安全策略阻止了访问,请检查网络环境配置。若仍无法解决,请通过在线提单提交问题。 |
| 404 | 找不到服务。 | 请检查请求URI是否正确。 |
| 405 | 不支持的http请求method。 | 请检查http请求method是否与接口说明一致。 |
| 500 | 服务内部错误。 | 请通过在线提单提交问题。 |
| 502 | 请求连接异常,常见于网络状况不稳定。 | 建议稍后重试,若仍无法解决,请通过在线提单提交问题。 |
| 503 | 系统流控。 | 触发系统流控,请稍后重试。 |
| 504 | 请求连接超时,常见于网络状况不稳定。 | 建议稍后重试,若仍无法解决,请通过在线提单提交问题。 |
| 590 | 服务内部错误。 | 请通过在线提单提交问题。 |
| 业务响应主错误码 | 业务响应子错误码 | 描述 | 解决方法 |
|---|---|---|---|
| 1203 | 100305 | id_token的header解析成功后的内容不是JSON格式。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1203 | 100306 | id_token的payload解析成功后的内容不是JSON格式。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1203 | 150021 | id_token的header解析失败。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1203 | 150022 | id_token的payload解析失败。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1203 | 150023 | id_token的signature解析失败。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1400 | 14004 | 无法通过其kid找到对应的JWT公钥相关信息。 | 请通过在线提单提交问题。 |
| 1500 | 15003 | 无效的id_token。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1500 | 15004 | id_token验证失败。 | id_token格式错误或者伪造的id_token,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1500 | 15005 | id_token的issuer验证失败。 | id_token的issuer校验失败,请检查id_token参数值是否为华为账号返回的原始值。 |
| 1500 | 15006 | id_token已过期。 | 请重新获取新的id_token。 |
| 1500 | 15007 | id_token为空。 | 请按照接口参数的要求,传入正确的id_token参数。 |
| 1500 | 15008 | id_token格式不正确。 | 检查id_token的格式是否满足正则:^[0-9a-zA-Z_\-\.]+$。 |
| 1203 | 500 | 系统内部错误。 | 系统内部处理错误,建议打印错误码信息,并请通过在线提单提交问题。 |
| 1203 | 1203 | 系统未知异常。 | 系统未知异常,建议打印错误码信息,并请通过在线提单提交问题。 |