Chaitin Tech whitelist/directory/list API

白名单管理/目录/列表

OpenAPI Specification

chaitin-whitelist-directory-list-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account whitelist/directory/list API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: whitelist/directory/list
  description: 白名单管理/目录/列表
paths:
  /whitelist/directory/list:
    post:
      summary: 目录白名单列表
      deprecated: false
      description: ''
      tags:
      - whitelist/directory/list
      parameters:
      - name: page
        in: query
        description: ''
        required: true
        example: '1'
        schema:
          type: string
      - name: limit
        in: query
        description: ''
        required: true
        example: '10'
        schema:
          type: string
      - name: search
        in: query
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: X-CS-Header-App
        in: header
        description: 应用id
        required: true
        example: '{{app}}'
        schema:
          type: string
      - name: X-CS-Header-Company
        in: header
        description: 公司id
        required: true
        example: '{{company_id}}'
        schema:
          type: string
      - name: X-CS-Header-Crypt
        in: header
        description: 加密算法,请参考:https://servaltech.feishu.cn/docs/doccnQCZ2cw32uazgNSO0DFwceb
        required: true
        example: ''
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 对于支持「ETAG」的接口,将上一次请求的响应header的Etag,填入到下一次请求。若匹配,则返回304(无变更),否则会返回新版本的数据 + 新Etag
        required: true
        example: string
        schema:
          type: string
      - name: X-CS-Header-Debug
        in: header
        description: ''
        required: true
        example: '{{debug}}'
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: ''
        required: true
        example: zh
        schema:
          type: string
      - name: X-Cs-Header-Timezone
        in: header
        description: ''
        required: true
        example: Asia/Shanghai
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Accept
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                family:
                  type: string
                queries:
                  type: array
                  items: {}
                source:
                  type: string
              required:
              - family
              - queries
              - source
            example:
              family: Windows
              queries: []
              source: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            create_by:
                              type: object
                              properties:
                                uid:
                                  type: string
                                name:
                                  type: string
                                username:
                                  type: string
                                email:
                                  type: string
                              required:
                              - uid
                              - name
                              - username
                              - email
                            company_id:
                              type: string
                            uid:
                              type: string
                            create_time:
                              type: string
                            update_by_id:
                              type: string
                            family:
                              type: string
                            description:
                              type: string
                            update_time:
                              type: string
                            source:
                              type: string
                            dir:
                              type: string
                      page:
                        type: integer
                    required:
                    - total
                    - results
                    - page
                required:
                - code
                - msg
                - data
              example:
                code: 0
                msg: success
                data:
                  total: 1
                  results:
                  - create_by:
                      uid: 2834ded5-b1c5-49ff-9655-3d4cc842e2b7
                      name: lbb
                      username: lbb
                      email: 123@123.com
                    company_id: eeff7c64-5070-4582-8b93-fbcc57db7771
                    uid: 50cbac58-2b2d-4086-a368-6e0245d15727
                    create_time: '2024-07-07T08:31:01.554280Z'
                    update_by_id: 2834ded5-b1c5-49ff-9655-3d4cc842e2b7
                    family: Linux
                    description: string
                    update_time: '2024-07-07T08:31:01.554419Z'
                    source: av_scan
                    dir: string
                  page: 1
      security: []