AuthMeData

Schema: AuthMeData

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    AuthMeData:
      type: object
      description: data of GET /auth/me/detail
      properties:
        id:
          type: integer
          format: int64
          description: Operator account ID
        username:
          type: string
          description: Login username
        realname:
          type: string
          description: Real name
        email:
          type: string
          description: Email
        phone:
          type: string
          description: Phone number in plain text
        primaryRoleName:
          type: string
          description: Primary role name (display)
        activeState:
          allOf:
            - $ref: '#/components/schemas/ActiveState'
          description: Enabled status
        mfaBound:
          type: boolean
          description: Whether Google Authenticator is bound
        isSuperAdmin:
          type: boolean
          description: Whether the user is a system super-admin (has is_system=1 role)
        roles:
          type: array
          items:
            $ref: '#/components/schemas/AuthRoleItem'
          description: Bound roles
        menus:
          type: array
          items: &ref_0
            $ref: '#/components/schemas/AuthMenuNode'
          description: Sidebar menu tree
        permCodes:
          type: array
          items:
            type: string
          description: Flat permission code list
        apiPerms:
          type: array
          description: APIs the current user may access (including Google Auth requirement)
          items:
            type: object
            properties:
              path:
                type: string
                description: API path
              method:
                type: string
                description: API HTTP method
              requireGoogleAuth:
                type: boolean
                description: Whether Google 2FA is required
            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: Menu / permission ID
        parentId:
          type: integer
          format: int64
          description: Parent node ID; top level is 0
        permCode:
          type: string
          description: Menu permission code
        permName:
          type: string
          description: Menu display name
        icon:
          type: string
          description: Menu icon
        path:
          type: string
          description: Frontend route
        sortNo:
          type: integer
          description: Sort order
        children:
          type: array
          items: *ref_0
          description: Submenu
      x-apifox-orders:
        - id
        - parentId
        - permCode
        - permName
        - icon
        - path
        - sortNo
        - children
      x-apifox-folder: ''
    AuthRoleItem:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Role ID
        roleName:
          type: string
          description: Role name
      x-apifox-orders:
        - id
        - roleName
      x-apifox-folder: ''
    ActiveState:
      type: string
      enum:
        - enabled
        - disabled
      description: Active state (aligned with common/consts.ActiveState)
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []