页内导航:

查询用户身份信息

使用场景: 用户登录授权完成后,第三方应用可通过此接口查询用户身份信息

权限项 说明 备注
应用是否需要申请白名单
用户凭证 支持
机构凭证 未支持 -

请求方式: GET(HTTPS

请求地址: https://test-oapi.epaas.qq.com/account/userinfo?access_token=ACCESS_TOKEN

请求参数:

参数 必须 类型 说明
access_token string 调用接口凭证,使用用户凭证(用户态access_token)
is_need_account bool 是否返回账号 默认:否
is_need_group bool 是否返回用户组 默认:否

返回参数:

参数 类型 说明
errcode int 返回码
errmsg string 对返回码的文本描述内容
user_name string 用户姓名昵称
role_id uint32 角色id, 参考角色类型
userid string 用户id,在机构内唯一
corpid uint64 教育号平台 CorpId
avatar string 用户头像链接
corp_type uint32 当前机构类型, 0:DEFAULT; 1:代理商; 2:上级单位; 4:学校; 5:超管; 9:租户后台; 7: 开放注册机构
corp_name string 机构名称
child_id uint32 孩子的用户id(家长身份登录时返回)
login_factors []string 登录因子
tenant_id string 租户id
phone string 加密后的手机号(参考附录参数加解密说明 里开放接口参数加解密章节)
group_id_list []uint32 用户组id列表, 参考用户组类型
tenant_menu []string 租户的分级管理员配置的可见菜单列表,当前可配置的菜单有: "org":组织中心, "appCenter":应用中心, "IOT":物联中心
tenant_admin_type uint32 租户管理员类型,参考租户管理员类型
school_property string 机构类型为学校时,会返回学校性质,参数值含义参考《学校类型对照表》
is_org_manager bool 是否为机构管理员

返回示例:

{
    "errcode": 0,
    "errmsg": "ok",
    "user_name": "用户1",
    "appid": "10000",
    "role_id": 12,
    "userid": "30000000",
    "corpid": 80000,
    "avatar": "https://smart20-1253364609.cos.ap-beijing.myqcloud.com/2021/202106/20210616/EWaAeXFz46b_yY7QwG.png",
    "corp_type": 4,
    "corp_name": "测试学校",
    "child_id": "20000000",
    "login_factors": [
       "CLASS_CODE"
    ],
    "tenant_id": "1",
    "phone": "xxxx",
    "group_id_list": [
        49
    ],
    "tenant_menu": [
        "org",
        "appCenter",
        "IOT"
    ],
    "tenant_admin_type": 2
}
© 1998 - 2021 Tencent Inc. All Rights Reserved all right reserved,powered by ePaaS.更新时间: 2024-08-22 10:14:39

results matching ""

    No results matching ""

    results matching ""

      No results matching ""