Chaitin Tech whitelist/email/list API

白名单管理/邮件/列表

OpenAPI Specification

chaitin-whitelist-email-list-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account whitelist/email/list API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: whitelist/email/list
  description: 白名单管理/邮件/列表
paths:
  /whitelist/email/list:
    post:
      summary: 邮件白名单列表
      deprecated: false
      description: ''
      tags:
      - whitelist/email/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: Accept
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      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:
                            update_time:
                              type: string
                            uid:
                              type: string
                            create_by:
                              type: 'null'
                            name:
                              type: string
                            description:
                              type: 'null'
                            create_time:
                              type: string
                            company_id:
                              type: string
                            update_by_id:
                              type: 'null'
                            value_list:
                              type: array
                              items:
                                type: string
                          required:
                          - update_time
                          - uid
                          - create_by
                          - name
                          - description
                          - create_time
                          - company_id
                          - update_by_id
                          - value_list
                      page:
                        type: integer
                    required:
                    - total
                    - results
                    - page
                required:
                - code
                - msg
                - data
              example:
                code: 0
                msg: success
                data:
                  total: 2
                  results:
                  - update_time: '2024-08-04T19:53:51Z'
                    uid: eeff7c64-5070-4582-8b93-fbcc57db7773
                    create_by: null
                    name: asd
                    description: null
                    create_time: '2024-08-04T19:53:47Z'
                    company_id: eeff7c64-5070-4582-8b93-fbcc57db7771
                    update_by_id: null
                    value_list:
                    - '3'
                    - '4'
                  - update_time: '2024-08-04T19:53:51Z'
                    uid: eeff7c64-5070-4582-8b93-fbcc57db7772
                    create_by: null
                    name: asd
                    description: null
                    create_time: '2024-08-04T19:53:47Z'
                    company_id: eeff7c64-5070-4582-8b93-fbcc57db7771
                    update_by_id: null
                    value_list:
                    - '1'
                    - '2'
                  page: 1
      security: []