Online Documentation

接入在线文档

接入前必读

当要开始将应用接入统一身份认证时,请确认申请的应用是否已通过管理员审核通过
在应用申请填写应用基本信息时,填写的应用服务器地址和端口,这里填写的是域名或ip,而不是URL,请勿加http://等协议头。
比如填写的应用服务器地址和域名为,zju.edu.cn,在使用CAS Client或OAuth进行接入或鉴权时,访问此服务器域名下的http://zju.edu.cn/main.do、http://zju.edu.cn/login.htm都可进行接入或鉴权,而不被拦截。而http://t.zju.edu.cn下的请求无法接入或鉴权
应用审核通过后,会为应用生成唯一的appkey和appsecret,开发者可使用它们选择合适的方式接入,也可进行接口调用。
根据应用申请时选择的接入方式,查看相应的接入指南,也可下载相应语言的示例代码进行本地调试。

全局返回码说明

在正式接入、调试或调用接口时,可能获得正确或错误的返回码,开发者可以根据返回码信息调试接口,排查错误。

全局返回码说明如下:
返回码 说明

CAS Client接入指南(JAVA版本)示例代码下载

客户端配置
eqwewqe获取用户详细信息接口

正在建设中...

正在建设中...

OAuth接入指南示例代码下载

使用OAuth接入应用,由如下三步完成接入:
第一步通过身份认证,获取code
第二步根据code获取access_token
第三步根据access_token获取用户信息
通过构造授权认证url并请求将跳转至用户身份授权地址,进行身份认证,参考链接如下: http://cas.gate.com:8000/cas/oauth2.0/authorize?response_type=code&client_id=APPKEY&redirect_uri=REDIRECT_URI

注意:跳转回调redirect_uri,应当使用https链接来确保授权code的安全性

http://cas.gate.com:8000/cas/oauth2.0/authorize
GET
参数 是否必须 说明
当输入正确的口令认证通过后,页面将跳转至redirect_uri/?code=CODE&state=STATE

注意:为授权安全,code只能使用一次,并且有效期为10秒,未被使用将自动过期

这里注意,用code换取的access_token与RestFul API中获取的token不同。构造获取access_token链接参考如下: http://cas.gate.com:8000/cas/oauth2/accessToken?client_id=APPID&client_secret=SECRET&code=CODE&redirect_uri=REDIRECT_URI
http://cas.gate.com:8000/cas/oauth2.0/accessToken
GET
参数 是否必须 说明

正确时返回的JSON数据包如下:

参数 说明

错误时返回的JSON数据包如下:

第三步:通过access_token,构造获取身份信息链接请求,参考链接如下: http://cas.gate.com:8000/cas/oauth2.0/profile?access_token=ACCESS_TOKEN
http://cas.gate.com:8000/cas/oauth2.0/profile
GET
参数 是否必须 说明

正确时返回的JSON数据包如下:

错误时返回的JSON数据包如下:

RestFul API接入指南示例代码下载

使用RestFul AP接入应用,只需调用相应接口即可完成接入。

1、我们提供接口的方式认证用户,如需实现单点登录将认证返回的Token写入浏览器cookie即可
2、实现从浏览器中获取token并调用相应接口,获取用户身份信息

http://cas.gate.com:8000/im/v2/identify.zf
POST
参数说明 参数 是否必须

正确时返回的JSON数据包如下:

参数 是否必须 说明

错误时返回的JSON数据包如下:

将token写入浏览器cookie中,cookie名为iPlanetDirectoryPro,cookie值为获取的token值,cookie域名为cas.gate.com

http://cas.gate.com:8000/im/v2/session.zf
POST
参数 是否必须 说明

正确时返回的JSON数据包如下:

错误时返回的JSON数据包如下:

SAML2.0接入指南

使用SAML2.0接入应用,需要在应用申请时上传 service provider(SP) XML

identity provider(IDP) Metadata XML请求地址为https://saml.gate.com/idp/shibboleth

第一步:通过如上给出的IDP XML请求地址,下载IDP Metadata配置文件

第二步:配置SP shibboleth2.xml

修改|找回密码

修改|找回密码接口
http://cas.gate.com:8000/im/v2/modifyPwd.zf
POST
参数 是否必须 说明

注意:newpassword参数为非必传,如传值,则密码修改为该值;如未传值,密码初始化为该用户证件号后六位。如用户证件号为空,密码修改默认为用户名.

正确时返回的JSON数据包如下:

错误时返回的JSON数据包如下:

获取用户详细信息接口

获取用户详细信息接口
http://cas.gate.com:8000/im/v2/getUserDetails.zf
POST
参数 是否必须 说明

正确时返回的JSON数据包如下:

参数 是否必须 说明

错误时返回的JSON数据包如下:

统一注销

统一注销可以调用接口,或应用系统直接使用超链接即可
链接地址示例:
http://cas.gate.com:8000/cas/logout?service=跳转url
调用统一注销接口
http://cas.gate.com:8000/cas/v2/delTicket
POST
参数 是否必须 说明