top
关闭

开发者登录

认证类接口

主要使用场景:第三方应用接入平台后,需要与平台会话保持一致时使用

1、验证ticket信息7.0

基础 需要授权

根据ticket验证ticket信息,ticket为一次性调用

前置条件

获取接口访问凭证:accessToken

请求说明

urlhttps://gateway.tianyuyun.com/user/openapi/user/verify-ticket-info?ticket=**&accessToken={{accessToken}}
请求方式get
是否需要鉴权
请求数限制
接口方向第三方应用->开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

ticket

必选

String

64

ticket

返回说明

序号 字段名 约束 类型 长度 说明

1

code

必选

string

结果编码

2

message

必选

string

结果描述

3.0

usession_id

必选

string

用户会话编号

3

result

可选

json

结果对象

3.1

user_id

必选

string

用户编号

3.2

platform_code

必选

string

平台编号

3.3

v_platform_code

必选

string

虚拟平台编号(多值用逗号分隔)

3.4

name

必选

string

用户姓名

3.5

gender

必选

int

性别(0:女,1:男,2:未填,3:保密)

3.6

birthdate

必选

string

出生日期

3.7

status

必选

int

状态(0:未激活, 1:正常, 2:注销, 3:锁定, 4:安管锁定)

3.8

province_code

必选

string

所在省

3.9

city_code

必选

string

所在市

3.10

area_code

必选

string

所在区

3.11

user_family

必选

json数组

用户家庭关系(识别init_user_type等于0是学生, 或识别user_top_org里的user_type等于0是学生,反之user_family不为空的就是家长,)

3.11.1

bind_user_id

必选

string

被绑定的用户id

3.11.2

relation_name

必选

string

绑定的称谓

3.11.3

relation_type

必选

string

绑定的家庭关系(正数时:被绑定的是家长,负数时:被绑定的是学生)

3.12

user_org

必选

json数组

用户所属部门、班级等节点

3.12.1

org_id

必选

string

用户所属部门、班级等节点id

3.12.2

top_org_id

必选

string

部门、班级所属的机构、学校id

3.12.3

org_type

必选

string

组织类型("1": "机构","2": "学校","3": "校区","4": "部门","5": "学段","6": "年级","7": "班级","8": "企业机构","9": "教学工作室","10": "平台")

3.12.4

attr

必选

json数组

用户在部门、班级等节点里的独立属性数据(例如class_teacher_subject教师班级任教学科信息、class_header_teacher班级班主任标识、class_monitor_student班级班长标识)

3.12.5

org_name

必选

string

用户所在部门、班级等节点名称

3.12.6

top_org_name

必选

string

用户所在机构、学校的名称

3.12.7

top_school_id

可选

string

仅在当前节点是校区、学段、年级、班级时返回所在的校区id

3.12.8

top_school_name

可选

string

仅在当前节点是校区、学段、年级、班级时返回所在的校区名称

3.13

user_top_org

必选

json数组

用户所属机构、学校等组织

3.13.1

name

必选

string

用户在所属组织里的名称

3.13.2

org_type

必选

string

用户所属组织的组织类型("1": "机构","2": "学校","3": "校区","4": "部门","5": "学段","6": "年级","7": "班级","8": "企业机构","9": "教学工作室","10": "平台")

3.13.3

user_type

必选

string

用户在所属组织的用户类型(0:学生,1:老师,2:家长,3:工作人员,4:机构人员,5:企业人员,12:市民)

3.13.4

org_id

必选

string

用户所属组织的组织id

3.13.5

top_org_name

必选

string

用户所属组织的组织名称

3.14

user_role

必选

json数组

用户权限或用户岗位信息 1、主管理员,查找user_role下top_org_id=组织id,且parent_id=1. 2、子管理员,查找user_role下top_org_id=组织id,且parent_id=2. 2.1、管理范围判断:查找power_name=sub_manager_department,且power_value包含all或者部门id 2.2、基础权限判断:查找power_name=sub_manager_app,且power_value包含all或者基础权限id 2.3、应用权限判断:查找power_name=sub_manager_campus,且power_value包含all或者应用id

3.14.1

parent_id

必选

string

当值为数字类型时,表示平台系统设置的默认角色,如1为主管理员,2为子管理员,更多默认角色列表参考获取默认角色接口 当值为字符串类型时,表示组织内自定义岗位,如 后勤管理 等,若想取得自定义岗位名称,可使用下面的role_id信息,通过获取角色详情接口获取

3.14.2

role_id

必选

string

自定义角色/岗位id

3.14.3

top_org_id

必选

string

角色/岗位所属机构、学校等组织id

3.14.4

org_id

必选

string

角色/岗位所属部门id

3.14.5

role_type

必选

string

角色/岗位类型,0系统,1普通,2自定义,废弃

3.14.6

_power

必选

json数组

子管理员权限信息,包含部门管理范围、基础权限、应用权限三个部分

3.14.6.1

power_name

必选

string

权限类型 1、sub_manager_department:部门管理范围,如全学校、所在部门等 2、sub_manager_app:基础权限,将在以上部门管理范围配置权限,如成员管理、设置管理 3、sub_manager_campus:应用权限

3.14.6.2

power_value

必选

数组

权限值,与power_name关联。”all”表示全部权限,其他权限对应如下: 1、power_name为sub_manager_department表示部门管理范围。power_value取值,all:全学校,dep:所在部门及下级部门,部门ids:多个部门id逗号分隔,表示管理特定部门 2、power_name为sub_manager_app表示基础权限。power_value取值,1:成员管理,6:组织管理,7:班级管理,3:工作台管理,4:设置,5:门户管理,8:资源库管理,9:数据管理,10:权限管理,11:数据上报 3、power_name为sub_manager_campus表示应用权限,power_value取值参照获取机构权限应用列表接口

3.15

avatar

必选

json

用户头像(1:小, 2:中, 3:大)

3.16

last_top_org_id

必选

string

最后切换的机构、学校等组织编号

3.17

last_top_org_name

必选

string

最后切换的机构、学校等组织名称

3.18

last_user_type

必选

int

最后所属的用户类型(0:学生,1:老师,2:家长,3:工作人员,4:机构人员,5:企业人员,12:市民)

3.19

init_user_type

必选

int

用户初始注册用户类型(0学生,1老师,2家长等等)

3.20

init_v_platform_code

必选

string

用户初始虚拟平码编码

示例

请求示例
https://gateway.tianyuyun.com/user/openapi/user/verify-ticket-info?ticket=**&accessToken={{ACCESS_TOKEN}}

返回示例
{
  "code": "000000",
  "message": "请求成功",
  "result": {
      "usession_id": "1291f592-7519-11e9-a1f3-0200f7934077",
      "xxxx": "xxxx",
      "yyyy": "yyyy",
    }
}