申请access_token

简述:

  • 传入授权AppKey,申请access_token

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:

暂无

  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
grant_type String 请求类型,可选值为:authorization_code/password_credentials/client_credentials/refresh_token
authorize_code String 调用authorize获得的code值,grant_type为authorization_code时必填
client_id String 申请应用时分配的AppKey
client_secret String 申请应用时分配的AppSecret
refresh_token String 调用access_token获得的refresh_token值,grant_type为refresh_token时必填
username String 用户名
password String 密码,grant_type为password_credentials时必填
redirect_uri String 回调地址

请求参数示例:

示例1:

{
    "client_id": "ibps",
    "client_secret": "58b65297-3467-0859-8337-8cbaf81ef68a",
    "authorize_code": "6173f3c0f9fa11e906ee9dff8b7b5da8",
    "grant_type": "authorization_code"
}

示例2:

{
    "client_id": "ibps",
    "client_secret": "58b65297-3467-0859-8337-8cbaf81ef68a",
    "grant_type": "client_credentials"
}

示例3:

{
    "client_id": "ibps",
    "client_secret": "58b65297-3467-0859-8337-8cbaf81ef68a",
    "username": "ibps",
    "username": "123456",
    "grant_type": "password_credentials"
}

示例4:根据刷新token值请求新token

{
    "refresh_token": "58b65297-3467-0859-8337-8cbaf81ef68a",
    "grant_type": "refresh_token"
}

返回示例:

结果1:

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "access_token": "61797200f9fa11e906ee9dff8b7b5da8",
        "refresh_token": "61797201f9fa11e906ee9dff8b7b5da8",
        "primary_refresh_token": null,
        "uid": "626353848415420416",
        "publisher": null,
        "applicant": null,
        "expires_in": 28800,
        "remind_in": 259200
    }
}

返回参数说明:

名称 类型 备注
access_token String 系统令牌值,简称token
refresh_token String 用于刷新请求新token的刷新令牌
primary_refresh_token String
uid String 用户ID
publisher String
applicant String
expires_in Integer token的生命周期,单位秒
remind_in Integer refresh_token的生命周期,单位秒

获取令牌列表

简述:

  • 获取令牌列表,获取令牌列表

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
request APIRequest[1] 动态查询请求对象

请求参数示例:

{
  "requestPage": {
    "pageNo": 1,
    "limit": 15
   }
}

返回示例:

{
  "state": 200,
  "request": null,
  "message": "",
  "cause": "",
  "variables": {},
  "data": {
    "dataResult": [
      {
        "accessToken": "7d9a03d0fa1a11e9c9869cf7db4dca77",
        "refreshToken": "7d9a03d1fa1a11e9c9869cf7db4dca77",
        "identity": "ccc",
        "identityType": "user",
        "accessTokenTtlSeconds": 26348,
        "refreshTokenTtlSeconds": 256748,
        "accessTokenTtlDate": "2019-10-29 23:05:29",
        "refreshTokenTtlDate": "2019-11-01 15:05:29"
      },
      {
        "accessToken": "e3bef280f9f011e906ee9dff8b7b5da8",
        "refreshToken": "e3bef281f9f011e906ee9dff8b7b5da8",
        "identity": "tom",
        "identityType": "user",
        "accessTokenTtlSeconds": 8481,
        "refreshTokenTtlSeconds": 238881,
        "accessTokenTtlDate": "2019-10-29 18:07:42",
        "refreshTokenTtlDate": "2019-11-01 10:07:42"
      }
    ],
    "pageResult": {
      "limit": 15,
      "page": 1,
      "totalCount": 2,
      "totalPages": 1
    }
  }
}

返回参数说明:

名称 类型 备注
dataResult Array 令牌列表数据
pageResult Object 分页数据

令牌删除

简述:

  • 传入令牌及类型,令牌删除

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
type String 令牌类型,可选值token/refresh
tokens List 令牌集合

请求参数示例:

待完善

返回示例:

待完善

返回参数说明:

  • 待完善
名称 类型 备注
data Object 待完善

切换用户

简述:

  • 传入已授权凭证,申请access_token,切换用户

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
grant_type String 请求类型,可选值authorization_code/password_credentials/client_credentials/refresh_token
client_id String 申请应用时分配的AppKey
client_secret String 申请应用时分配的AppSecret
access_token String 执行切换的管理员访问令牌
username String 切换目标用户名
redirect_uri String 回调地址

请求参数示例:

{
    "client_id": "ibps",
    "client_secret": "58b65297-3467-0859-8337-8cbaf81ef68a",
    "grant_type": "authorization_code",
    "access_token": "0d732c20fa2011e9c9869cf7db4dca77",
    "username": "admin"
}

返回示例:

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "access_token": "caf536c0fa2611e9c9869cf7db4dca77",
        "refresh_token": "caf55dd0fa2611e9c9869cf7db4dca77",
        "primary_refresh_token": "0d732c21fa2011e9c9869cf7db4dca77",
        "uid": null,
        "publisher": null,
        "applicant": null,
        "expires_in": 28800,
        "remind_in": 259200
    }
}

返回参数说明:

名称 类型 备注
access_token String 系统令牌值,简称token
refresh_token String 用于刷新请求新token的刷新令牌
primary_refresh_token String
uid String 用户ID
publisher String
applicant String
expires_in Integer token的生命周期,单位秒
remind_in Integer refresh_token的生命周期,单位秒

退出切换用户

简述:

  • 传入已授权凭证,申请access_token,退出切换用户

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
grant_type String 请求类型,可选值authorization_code/password_credentials/client_credentials/refresh_token
client_id String 申请应用时分配的AppKey
client_secret String 申请应用时分配的AppSecret
access_token String 执行切换的管理员访问令牌
username String 切换目标用户名
redirect_uri String 回调地址

请求参数示例:

{
    "client_id": "ibps",
    "client_secret": "58b65297-3467-0859-8337-8cbaf81ef68a",
    "grant_type": "authorization_code",
    "access_token": "caf536c0fa2611e9c9869cf7db4dca77",
    "username": "admin"
}

返回示例:

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "access_token": "84f395b0fa2911e9c9869cf7db4dca77",
        "refresh_token": "84f395b1fa2911e9c9869cf7db4dca77",
        "primary_refresh_token": null,
        "uid": "626353848415420416",
        "publisher": null,
        "applicant": null,
        "expires_in": 28800,
        "remind_in": 259200
    }
}

返回参数说明:

名称 类型 备注
access_token String 系统令牌值,简称token
refresh_token String 用于刷新请求新token的刷新令牌
primary_refresh_token String
uid String 用户ID
publisher String
applicant String
expires_in Integer token的生命周期,单位秒
remind_in Integer refresh_token的生命周期,单位秒

校验令牌

简述:

  • 传入令牌,校验令牌

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:

暂无

  • Query:
名称 类型 是否必须 默认值 备注 其他信息
access_token String 访问令牌
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/oauth2/v3/authentication/verify?access_token=84f395b0fa2911e9c9869cf7db4dca77

返回示例:

{
  "state": 200,
  "request": null,
  "message": "",
  "cause": "",
  "variables": {
    "clientId": "ibps",
    "grant.type": "authorization_code"
  },
  "data": "zjh"
}

返回参数说明:

名称 类型 备注
data String 用户名
variables.clientId String 申请应用时分配的AppKey
variables.grant.type String 请求类型

备注

文档更新时间: 2019-10-31 11:39   作者:Eddy