获取登录用户信息

POST

/cgi-bin/service/get_login_info

服务端API第三方应用开发智慧硬件开发

第三方可通过如下接口，获取登录用户的信息。建议用户以返回信息中的corpid及userid为主键匹配用户。

注意：因历史原因，该接口在调用失败时才返回errcode。没返回errcode视为调用成功

文档ID: 14957
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/91125
https://open.work.weixin.qq.com/api/doc/90002/90151/91158

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qyapi.weixin.qq.com/cgi-bin/service/get_login_info?access_token=PROVIDER_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{"auth_code":"xxxxx"}'

响应示例

{
    "errcode": 0,
    "errmsg": "ok",
    "usertype": 1,
    "user_info": {
        "userid": "xxxx",
        "open_userid": "xxx",
        "name": "xxxx",
        "avatar": "xxxx"
    },
    "corp_info": {
        "corpid": "wxCorpId"
    },
    "agent": [
        {
            "agentid": 0,
            "auth_type": 1
        },
        {
            "agentid": 1,
            "auth_type": 1
        },
        {
            "agentid": 2,
            "auth_type": 1
        }
    ],
    "auth_info": {
        "department": [
            {
                "id": 2,
                "writable": true
            }
        ]
    }
}

请求参数

Query 参数

access_token

必需

授权登录服务商的网站时，使用应用提供商的provider_access_token，获取方法参见服务商的凭证

示例值:

PROVIDER_ACCESS_TOKEN

Body 参数application/json

auth_code

string

必需

oauth2.0授权企业微信管理员登录产生的code，最长为512字节。只能使用一次，5分钟未被使用自动过期

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

可选

返回码。若返回该字段，并且errcode!=0，为调用失败；无此errcode字段，或者errcode=0，为调用成功

agent

array [object {2}]

可选

该管理员在该提供商中能使用的应用列表，当登录用户为管理员时返回

agentid

integer <int32>

应用id

可选

auth_type

integer <int32>

可选

该管理员对应用的权限：1.管理权限，0.使用权限

user_info

object

登录用户的信息

可选

name

string

可选

登录用户的名字，登录用户在通讯录中时返回，此字段从2019年12月30日起，对新创建服务商不再返回，2020年6月30日起，对所有历史服务商不再返回真实name，使用userid代替name返回，第三方页面需要通过通讯录展示组件来展示名字

avatar

string

可选

登录用户的头像，登录用户在通讯录中时返回

open_userid

string

可选

全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。登录用户在通讯录中返回

userid

string

可选

登录用户的userid，登录用户在通讯录中时返回

errmsg

string

可选

对返回码的文本描述内容。仅当errcode字段返回时，同时返回errmsg

usertype

integer <int32>

可选

登录用户的类型：1.创建者 2.内部系统管理员 3.外部系统管理员 4.分级管理员 5.成员

corp_info

object

授权方企业信息

可选

corpid

string

授权方企业id

可选

auth_info

object

可选

该管理员拥有的通讯录权限，当登录用户为管理员时返回

department

array [object {2}]

可选

接入指引

概述