文档中心

checkid_setup(间接)

接口名称 间接登录
功能简介 该接口接收RP通过UA向OP发起的登录请求,OP完成用户身份认证,并返回代表登录用户的ServiceTicket,RP接收到返回参数后,再调用另外的Check_Authentication接口进行效验并获取当前登录用户。
Rest接口 /v2
通信方式 间接
请求方式 redirect
请求参数
  • openid.mode = checkid_setup
  • openid.return_to :RP接收OP登录返回的URL地址
  • openid.ex.client_id :OP分配给RP,代表RP身份的ID
  • (可选)openid.ex.auth_type : 当OP支持多种认证方式时,可通过此参数指定当前的请求使用哪种认证方式,目前支持form和ntlm两种,如果不传递该参数,则使用OP默认的认证方式
  • (可选)用户凭证:支持RP带着用户凭证向OP发起登录请求,OP将验证该凭证,如果通过则向RP返回,不通过,则跳转到OP的登录页面,让用户完成登录,再向RP返回登录结果。
用户凭证,可以支持多种,目前只支持用户口令。
1、用户口令:credential_type、username、password三个参数,其中credential_type=password为固定值,username、password为用户的账号和口令
2、login_ticket:credential_type、login_ticket两个参数,其中credential_type=login_ticket,login_ticket参数为login_ticket_setup接口生成
成功响应
  • openid.mode=id_res
  • openid.ex.service_ticket: 代表登录用户的Token
失败响应
  • openid.mode=error
  • openid.error : 错误描述

checkid_setup(直接)

接口名称 直接登录
功能简介 UA直接向OP发起登录请求,OP处理登录请求,并返回登录结果。这里的使用场景是桌面应用或移动终端。
Rest接口 /v2
通信方式 直接
请求方式 post(增加Header头X-Requested-With=XMLHttpRequest)
请求参数
  • openid.mode = checkid_setup
  • openid.ex.client_id :OP分配给RP,代表RP身份的ID
  • (可选)用户凭证:支持RP带着用户凭证向OP发起登录请求,OP将验证该凭证,如果通过则向RP返回,不通过,则跳转到OP的登录页面,让用户完成登录,再向RP返回登录结果。
用户凭证,可以支持多种,目前只支持用户口令和应用专用密码。1、用户口令:credential_type、username、password三个参数,其中credential_type=password为固定值,username、password为用户的账号和口令2、应用专用密码:credential_type、username、password三个参数,其中credential_type=spec_secret为固定值,username、password为应用专用密码的账号和口令3、login_ticket:credential_type、login_ticket两个参数,其中credential_type=login_ticket,login_ticket参数为login_ticket_setup接口生成
  • openid.ex.get_spec_secret=y:OP根据这个来判断是否需要返回应用专用密码
  • openid.ex.get_service_ticket=y:OP根据这个来判断是否需要返回service_ticket
积极响应
  • mode=ok
  • identity: 用户标识
  • ex.token: 代表用户已经登录的Token
  • ex.token_expires: Token过期时间
  • ex.service_ticket: 用于RP效验用户是否登录的Token
  • ex.spec_secret: 应用专用密码
  • ex.spec_secret_expires: 应用专用密码过期时间
消极响应
  • mode=fail
  • error:错误描述文本

check_authentication

接口名称 用户登录效验
功能简介 RP向OP获取到service_ticket后,通过向OP调用该接口效验service_ticket的有效性,并返回当前登录用户identity。
Rest接口 /v2
通信方式 直接通信
请求方式 post
请求参数
  • openid.mode=check_authentication
  • openid.ex.client_id :OP分配给RP,代表RP身份的ID
  • openid.ex.client_secret :OP分配给RP的密钥,用来验证客户端身份
  • openid.ex.service_ticket : OP颁发的Token
  • openid.ex.logout_url : RP的注销地址
  • openid.ex.get_oauth_access_token=y:获取oauth的access_token
成功响应
  • mode=ok
  • identity : 用户标识
失败响应
  • mode=fail
  • error: 错误描述文本

checkid_immediate

接口名称 检查登录状态
功能简介 该接口接收RP通过UA向OP发起的登录检查请求,如果用户已经在OP登录,则返回代表登录用户的ServiceTicket,否则,返回告知RP,用户还没登录。
Rest接口 /v2
通信方式 间接
请求方式 redirect
请求参数
  • openid.mode = checkid_immediate
  • openid.return_to :RP接收OP登录返回的URL地址
  • openid.ex.client_id :OP分配给RP,代表RP身份的ID
  • (可选)用户凭证:支持RP带着用户凭证向OP发起登录请求,OP将验证该凭证,如果通过则向RP返回,不通过,则跳转到OP的登录页面,让用户完成登录,再向RP返回登录结果。
用户凭证,可以支持多种,目前只支持用户口令。
1、用户口令:credential_type、username、password三个参数,其中credential_type=password为固定值,username、password为用户的账号和口令
积极响应
  • openid.mode=id_res
  • openid.ex.service_ticket: 代表登录用户的Token
消极响应
  • openid.mode=setup_needed

service_ticket_setup

接口名称 service_ticket生成
功能简介 用户通过桌面/移动终端登录OP成功后,可通过OP颁发的Token向OP换取service_ticket,该service_ticket可用于桌面对应的后台应用登录。
Rest接口 /v2
通信方式 直接通信
请求方式 post
请求参数
  • openid.mode=service_ticket_setup
  • openid.ex.client_id :OP分配给RP,代表RP身份的ID
  • openid.ex.token : 用户登录成功后,OP返回的Token
积极响应
  • mode=ok
  • ex.service_ticket
消极响应
  • mode=token_invalid
  • error

login_ticket_setup

接口名称 login_ticket生成
功能简介 桌面客户端通过用户凭证到SSO去换取login_ticket,login_ticket代表用户身份已经验证通过;该login_ticket可用于桌面到桌面、桌面到Web的单点登录场景。
Rest接口 /v2
通信方式 直接通信
请求方式 post
请求参数
  • openid.mode=login_ticket_setup
  • openid.ex.token : 用户登录成功后,OP返回的Token
积极响应
  • mode=ok
  • ex.login_ticket
消极响应
  • mode=token_invalid
  • error

token_refresh

接口名称 刷新Token
功能简介 刷新Token,以免会话过期。
Rest接口 /v2
通信方式 直接通信
请求方式 post
请求参数
  • openid.mode=token_refresh
  • openid.ex.token : 用户登录成功后,OP返回的Token
积极响应
  • mode=ok
  • ex.token
  • ex.token_expires
消极响应
  • mode=token_invalid
  • error

logout(间接)

接口名称 间接注销
功能简介 注销用户会话,OP和RP的都注销。
Rest接口 /v2
通信方式 间接通信
请求方式 redirect
请求参数
  • openid.mode=logout
  • openid.return_to
成功响应
  • mode=logout_res

logout(直接)

接口名称 直接注销
功能简介 注销用户会话,只注销OP。
Rest接口 /v2
通信方式 直接通信
请求方式 post(增加Header头X-Requested-With=XMLHttpRequest)
请求参数
  • openid.mode=logout
  • openid.ex.token : 用户登录成功后,OP返回的Token
成功响应
  • mode=ok