You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

408 lines
9.7 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

definitions:
Model.AppInfo:
properties:
app_key:
type: string
app_name:
type: string
app_secret:
type: string
code:
type: integer
msg:
type: string
redirect_uri:
type: string
type: object
Model.Res:
properties:
code:
description: omitempty有值就输出没值则不输出
type: object
data:
description: omitempty有值就输出没值则不输出
type: object
items:
description: omitempty有值就输出没值则不输出
type: object
msg:
description: omitempty有值就输出没值则不输出
type: object
total_count:
description: 个数
type: object
type: object
host: 10.10.14.187:8000
info:
contact: {}
description: 参考自xxl-sso
license: {}
title: 东师理想统一认证中心(OAuth2+Sso)
version: "2.0"
paths:
/oauth2/access_token:
post:
consumes:
- application/x-www-form-urlencoded
description: 获取access_token
parameters:
- description: code
in: query
name: code
type: string
- description: refresh_token
in: query
name: refresh_token
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
type: string
summary: 获取access_token
tags:
- 登录验证类
/oauth2/authorize:
get:
consumes:
- application/x-www-form-urlencoded
description: 登录验证跳转路由
parameters:
- description: client_id
in: query
name: client_id
required: true
type: string
- description: redirect_uri
in: query
name: redirect_uri
required: true
type: string
- description: device_id
in: query
name: device_id
required: true
type: string
- description: 第三方系统回跳的页面地址
in: query
name: oauth_callback
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
type: string
summary: 登录验证跳转路由
tags:
- 登录验证类
x-emptylimit:
- client_id
- redirect_uri
- device_id
- oauth_callback
post:
consumes:
- application/x-www-form-urlencoded
description: 验证post
parameters:
- description: 验证码id
in: formData
name: captchaId
required: true
type: string
- description: 验证码值
in: formData
name: value
required: true
type: string
- description: 用户名
in: formData
name: username
required: true
type: string
- description: 密码
in: formData
name: password
required: true
type: string
- description: 设备ID
in: formData
name: device_id
required: true
type: string
- description: 第三方系统的接口回调地址
in: formData
name: redirect_uri
type: string
- description: 第三方系统的ID
in: formData
name: client_id
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.Res'
summary: 验证post
tags:
- 登录验证类
x-emptylimit:
- username
- password
- captchaId
- value
x-intlimit:
- device_id
/oauth2/getCaptcha:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取验证码(为了以后WEB服务器的集群扩展将验证码保存到redis中避免ip_hash)
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.Res'
summary: 获取验证码
tags:
- 登录验证类
/oauth2/getCaptchaPng:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取验证码图片
parameters:
- description: captchaId
in: query
name: captchaId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
type: string
summary: 获取验证码图片
tags:
- 登录验证类
x-lengthlimit:
- captchaId: 20,20
/oauth2/logout:
get:
consumes:
- application/x-www-form-urlencoded
description: 退出统一认证
parameters:
- description: redirect_uri
in: query
name: redirect_uri
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
type: string
summary: 退出统一认证
tags:
- 登录验证类
/oauth2/resetRemainCount:
get:
consumes:
- application/x-www-form-urlencoded
description: 重置错误重试次数限制
parameters:
- description: 登录用的用户名
in: query
name: userName
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
type: string
summary: 重置错误重试次数限制
tags:
- 登录验证类
x-emptylimit:
- userName
/sso/addJoinApp:
post:
consumes:
- application/x-www-form-urlencoded
description: 增加一条接入系统的记录
parameters:
- description: 系统名称
in: formData
name: app_name
required: true
type: string
- description: 回调的地址
in: formData
name: redirect_uri
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.Res'
summary: 增加一条接入系统的记录
tags:
- 接入系统维护类
x-lengthlimit:
- app_name: 1,30
- redirect_uri_1: 8,100
- redirect_uri_2: 8,100
/sso/deleteJoinAppById:
post:
consumes:
- application/x-www-form-urlencoded
description: 删除一条统一认证系统的记录
parameters:
- description: 系统app_id
in: formData
name: app_id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.Res'
summary: 删除一条统一认证系统的记录
tags:
- 接入系统维护类
x-intlimit:
- app_id
/sso/getJoinAppInfoById:
get:
consumes:
- application/x-www-form-urlencoded
description: 根据appId获取接入第三方统一认证系统的信息
parameters:
- description: 系统app_id
in: query
name: app_id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.AppInfo'
summary: 根据appId获取接入第三方统一认证系统的信息
tags:
- 接入系统维护类
x-intlimit:
- app_id
/sso/getJoinAppList:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取接入系统的列表
parameters:
- description: 每页多少条数据
in: query
name: limit
required: true
type: integer
- description: 显示第几页
in: query
name: page
required: true
type: integer
- description: 搜索的关键词
in: query
name: keyword
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.Res'
summary: 获取接入系统的列表
tags:
- 接入系统维护类
x-intlimit:
- limit
- page
x-lengthlimit:
- keyword: 0,20
/sso/login:
get:
consumes:
- application/x-www-form-urlencoded
description: manager dsideal4r5t6y7u 为统一认证管理员默认帐号
produces:
- application/json
responses:
"200":
description: OK
schema:
type: string
summary: 接入系统管理中心维护的路由跳转
tags:
- 接入系统维护类
/sso/updateJoinApp:
post:
consumes:
- application/x-www-form-urlencoded
description: 修改一条接入系统的记录
parameters:
- description: 系统app_id
in: formData
name: app_id
type: string
- description: 系统名称
in: formData
name: app_name
required: true
type: string
- description: 回调的地址
in: formData
name: redirect_uri
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/Model.Res'
summary: 修改一条接入系统的记录
tags:
- 接入系统维护类
x-intlimit:
- app_id
x-lengthlimit:
- app_name: 1,30
- redirect_uri_1: 8,100
- redirect_uri_2: 8,100
swagger: "2.0"