Skip to content

AuthMeData

Schema:AuthMeData

OpenAPI Specification

yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    AuthMeData:
      type: object
      description: GET /auth/me/detail 的 data
      properties:
        id:
          type: integer
          format: int64
          description: 运营账号 ID
        username:
          type: string
          description: 登录用户名
        realname:
          type: string
          description: 真实姓名
        email:
          type: string
          description: 邮箱
        phone:
          type: string
          description: 手机号明文
        primaryRoleName:
          type: string
          description: 主角色名称(展示用)
        activeState:
          allOf:
            - $ref: '#/components/schemas/ActiveState'
          description: 启用状态
        mfaBound:
          type: boolean
          description: 是否已绑定谷歌验证器
        isSuperAdmin:
          type: boolean
          description: 是否系统超管(拥有 is_system=1 角色)
        roles:
          type: array
          items:
            $ref: '#/components/schemas/AuthRoleItem'
          description: 已绑定角色
        menus:
          type: array
          items: &ref_0
            $ref: '#/components/schemas/AuthMenuNode'
          description: 侧栏菜单树
        permCodes:
          type: array
          items:
            type: string
          description: 扁平权限码列表
        apiPerms:
          type: array
          description: 当前用户允许访问的接口列表(包含是否需要谷歌验证)
          items:
            type: object
            properties:
              path:
                type: string
                description: 接口 path
              method:
                type: string
                description: 接口 HTTP 方法
              requireGoogleAuth:
                type: boolean
                description: 是否需要谷歌二次验证
            required:
              - path
              - method
              - requireGoogleAuth
            x-apifox-orders:
              - path
              - method
              - requireGoogleAuth
      x-apifox-orders:
        - id
        - username
        - realname
        - email
        - phone
        - primaryRoleName
        - activeState
        - mfaBound
        - isSuperAdmin
        - roles
        - menus
        - permCodes
        - apiPerms
      x-apifox-folder: ''
    AuthMenuNode:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: 菜单/权限 ID
        parentId:
          type: integer
          format: int64
          description: 父节点 ID;顶级 0
        permCode:
          type: string
          description: 菜单权限码
        permName:
          type: string
          description: 菜单显示名
        icon:
          type: string
          description: 菜单图标
        path:
          type: string
          description: 前端路由
        sortNo:
          type: integer
          description: 排序号
        children:
          type: array
          items: *ref_0
          description: 子菜单
      x-apifox-orders:
        - id
        - parentId
        - permCode
        - permName
        - icon
        - path
        - sortNo
        - children
      x-apifox-folder: ''
    AuthRoleItem:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: 角色 ID
        roleName:
          type: string
          description: 角色名称
      x-apifox-orders:
        - id
        - roleName
      x-apifox-folder: ''
    ActiveState:
      type: string
      enum:
        - enabled
        - disabled
      description: 启用状态(与 common/consts.ActiveState 一致)
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []