/接口文档
/业务中间件服务接口
/权限服务接口

权限服务接口

版本记录

版本号日期修改内容
0.12.32024-08-15修复已知问题

权限服务

登录—signIn

接口功能

用户登录。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
namestring是用户名
pwdstring是密码
loginclientstring是登录端
  1. 返回值参数说明
参数名称类型说明
tokenstring访问令牌
sidstring会话 id
needUpdatePasswdBoolean是否需修改密码
passwdExpireAtDateTime密码过期时间
tipUpdatePasswdBoolean是否需提醒修改密码
login2FAConfigstring双因子认证配置
  1. 示例介绍
mutation {
  signIn(name: "string", pwd: "string", loginclient: "WEB") {
    token
    sid
    needUpdatePasswd
    passwdExpireAt
    tipUpdatePasswd
    login2FAConfig
  }
}

用户注销—signOut

接口功能

用户注销。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
  1. 返回值参数说明
参数名称类型说明
databoolean是否成功
  1. 示例介绍
mutation {
  signOut {
    data
  }
}

修改密码—changePassword

接口功能

修改密码。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
changePasswordstring是原始密码
newPasswordstring是新密码
  1. 返回值参数说明
参数名称类型说明
databoolean是否成功
  1. 示例介绍
mutation {
  changePassword(password: "string", newPassword: "string") {
    data
  }
}

双因子登录—sign2FA

接口功能

双因子登录。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
namestring是账号
sidstring是会话 ID(signIn 接口在双因子开启后返回的参数)
verifyTypeInt是验证方式：1：邮箱，2：短信，3：app 扫码，4：一次一密，5：二次密码
codeInt否二次密码/二维码/邮箱验证码
loginclientstring否登录端，默认为 WEB
  1. 返回值参数说明
参数名称类型说明
tokenstring访问令牌
sidstring会话 id
needUpdatePasswdBoolean是否需修改密码
passwdExpireAtDateTime密码过期时间
tipUpdatePasswdBoolean是否需提醒修改密码
login2FAConfigstring双因子认证配置
  1. 示例介绍
mutation {
  sign2FA(data: { name: "string", sid: "string", verifyType: 1 }) {
    token
    sid
    needUpdatePasswd
    passwdExpireAt
    tipUpdatePasswd
    login2FAConfig
  }
}

在线用户管理—userOnline

接口功能

在线用户管理。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
accountstring否账户
personnelCodestring否
  1. 返回值参数说明
参数名称类型说明
accountstring用户名
ipstring访问 Ip
loginTimeBoolean登录时间
loginClientDateTime登录客户端
sidBoolean
personnelCodestring
  1. 示例介绍
mutation {
  userOnline(account: "string", personnelCode: "string") {
    account
    ip
    loginTime
    loginClient
    sid
    personnelCode
  }
}

在线用户强制退出—userOnlineOut

接口功能

在线用户强制退出。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
accountstring是
sidstring是
loginclientstring是
  1. 返回值参数说明
参数名称类型说明
databoolean是否成功
  1. 示例介绍
mutation {
  userOnlineOut(account: "string", sid: "string", loginClient: "WEB") {
    data
  }
}

验证 token 是否有效—validToken

接口功能

验证 token 是否有效。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
  1. 返回值参数说明
参数名称类型说明
databoolean是否成功
  1. 示例介绍
mutation {
  validToken {
    data
  }
}

校验 token，并获取用户信息—validTokenAndGetUserInfo

接口功能

校验 token，并获取用户信息。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
methodNamestring否方法名
  1. 返回值参数说明
参数名称类型说明
isValidBoolean是否有效，true：有效，false：无效
userInfoUserInfo会话 id
needUpdatePasswdBoolean用户信息，
1. 示例介绍 

mutation {
  validTokenAndGetUserInfo(methodName: "string") {
    isValid
    userInfo {
      id
      account
      name
      passwd
      passwdUpdateAt
      personnelCode
      validityPeriod
      companyCode
      rfid
      address
      telephone
      email
      sex
      wechat
      descriptionInfo
      avatar
      state
      createBy
      createdAt
      updatedBy
      updatedAt
      secretCode
      secPwd
      isDelete
      needUpdatePasswd
      userSource
      lastLoginTime
    }
  }
}

查询用户—findManyUserInfo

接口功能

查询用户。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
whereUserInfoWhereInput否查询条件
orderByUserInfoOrderByWithRelationInput否排序条件
cursorUserInfoWhereUniqueInput否游标
skipInt否跳过记录数
takeInt否获取记录数
distinctUserInfoScalarFieldEnum否过滤条件
  1. 返回值参数说明
参数名称类型说明
idString用户 ID
accountString用户名
usernameString姓名
passwdString密码
passwdUpdateAtDateTime密码修改时间
personnelCodeString人员编码
validityPeriodDateTime有效期
companyCodeString公司编码
rfidStringrfid
addressString地址
telephoneString手机号
emailString邮箱
sexInt性别
wechatString微信
descriptionInfoString描述
avatarString头像
stateInt用户状态
createByString创建人
createdAtDateTime创建时间
updatedByString修改人
updatedAtDateTime修改时间
secretCodeString一次一密密钥
secPwdString二次密码
isDeleteInt是否删除
needUpdatePasswdBoolean需要修改密码
userSourceString用户来源
lastLoginTimeDateTime最后登录时间
1. 示例介绍 

query
{
  {
  findManyUserInfo{
    id
    account
    name
    passwd
    passwdUpdateAt
    personnelCode
    validityPeriod
    companyCode
    rfid
    address
    telephone
    email
    sex
    wechat
    descriptionInfo
    avatar
    state
    createBy
    createdAt
    updatedBy
    updatedAt
    secretCode
    secPwd
    isDelete
    needUpdatePasswd
    userSource
    lastLoginTime
  }
}
}

查询用户权限—permissionOneUserInfo

接口功能

查询用户权限。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
whereUserInfoWhereInput否查询条件
  1. 返回值参数说明
参数名称类型说明
applicationIdString应用 ID
menus[MenuPermission]菜单
apis[String]api

| apiInfos | [ApiInfo] | Api 信息 | | dataGroups | [String] | | | dataGroupInfos | [DataGroup] | 数据组信息 |

1. 示例介绍 

{
  permissionOneUserInfo(where: {}) {
    applicationId
    applicationInfo {
      id
      applicationCode
      applicationName
      i18n
      applicationType
      isOtherApplication
      visitUrl
      imageUrl
      authType
      componentPath
      routeType
      openStyle
      description
      clientId
      clientSecret
      callbackUrl
      accessTokenOverUnit
      accessTokenOverValue
      refreshTokenOverUnit
      refreshTokenOverValue
      displayNavigation
      sort
      createBy
      createdAt
      updatedBy
      updatedAt
    }
  }
}

修改单个用户—updateOneUserInfo

接口功能

修改单个用户。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
whereUserInfoWhereInput否查询条件
dataUserInfoUpdateNoAccountInput!否数据
  1. 返回值参数说明
参数名称类型说明
idString用户 ID
accountString用户名
nameString姓名
passwdString密码
passwdUpdateAtDateTime密码修改时间
personnelCodeString人员编码
validityPeriodDateTime有效期
companyCodeString公司编码
rfidStringrfid
addressString地址
telephoneString手机号
emailString邮箱
sexInt性别
wechatString微信
descriptionInfoString描述
avatarString头像
stateInt用户状态
createByString创建人
createdAtDateTime创建时间
updatedByString修改人
updatedAtDateTime修改时间
secretCodeString一次一密密钥
secPwdString二次密码
isDeleteInt是否删除
needUpdatePasswdBoolean需要修改密码
userSourceString用户来源
lastLoginTimeDateTime最后登录时间
1. 示例介绍 

mutation {
  updateOneUserInfo(data: {}, where: {}) {
    id
    account
    name
    passwd
    passwdUpdateAt
    personnelCode
    validityPeriod
    companyCode
    rfid
    address
    telephone
    email
    sex
    wechat
    descriptionInfo
    avatar
    state
    createBy
    createdAt
    updatedBy
    updatedAt
    secretCode
    secPwd
    isDelete
    needUpdatePasswd
    userSource
    lastLoginTime
  }
}

资源导入—import

接口功能

资源导入。

接口地址

URL/api/graphql
http 请求方式post

参数

  1. 请求参数说明
名称类型是否必填描述
dataImportReqInfo!是
isOverwriteBoolean否是否覆写
  1. 返回值参数说明
参数名称类型说明
databoolean是否成功
  1. 示例介绍
mutation {
  import(data: {}, isOverwrite: true) {
    data
  }
}