Chaitin Tech policy/email/list API

策略管理/邮件/列表

OpenAPI Specification

chaitin-policy-email-list-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account policy/email/list API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: policy/email/list
  description: 策略管理/邮件/列表
paths:
  /policy/email/list:
    post:
      summary: 列表
      deprecated: false
      description: ''
      tags:
      - policy/email/list
      parameters:
      - 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:
                code:
                  type: integer
                msg:
                  type: string
                data:
                  type: object
                  properties:
                    total:
                      type: integer
                    results:
                      type: array
                      items:
                        type: object
                        properties:
                          uid:
                            type: string
                          status:
                            type: string
                          name:
                            type: string
                          description:
                            type: string
                          source:
                            type: string
                          scope:
                            type: string
                          action:
                            type: string
                          update_by:
                            type: object
                            properties:
                              uid:
                                type: string
                              name:
                                type: string
                              username:
                                type: string
                              email:
                                type: 'null'
                            required:
                            - uid
                            - name
                            - username
                            - email
                          update_time:
                            type: string
                    page:
                      type: integer
                  required:
                  - total
                  - results
                  - page
              required:
              - code
              - msg
              - data
            example:
              code: 0
              msg: success
              data:
                total: 1
                results:
                - uid: cfbb6e41-0526-46ce-ad1d-0e53062a615a
                  status: deactivated
                  name: 邮件策略
                  description: 策略描述
                  source: added
                  scope: global
                  action: notify
                  update_by:
                    uid: 7786a7f7-8047-47ec-905a-a622a2cf78dd
                    name: admin
                    username: admin
                    email: null
                  update_time: '2024-07-31T10:23:22.503590Z'
                page: 1
      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:
                            uid:
                              type: string
                            status:
                              type: string
                            name:
                              type: string
                            description:
                              type: string
                            source:
                              type: string
                            scope:
                              type: string
                            action:
                              type: string
                            update_by:
                              type: object
                              properties:
                                uid:
                                  type: string
                                name:
                                  type: string
                                username:
                                  type: string
                                email:
                                  type: string
                              required:
                              - uid
                              - name
                              - username
                              - email
                            update_time:
                              type: string
                          required:
                          - uid
                          - status
                          - name
                          - description
                          - source
                          - scope
                          - action
                          - update_by
                          - update_time
                      page:
                        type: integer
                    required:
                    - total
                    - results
                    - page
                required:
                - code
                - msg
                - data
              example:
                code: 6005
                msg: string
                data:
                  total: 9141
                  results:
                  - uid: string
                    status: string
                    name: string
                    description: string
                    source: string
                    scope: string
                    action: string
                    update_by:
                      uid: string
                      name: string
                      username: string
                      email: string
                    update_time: string
                  - uid: string
                    status: string
                    name: string
                    description: string
                    source: string
                    scope: string
                    action: string
                    update_by:
                      uid: string
                      name: string
                      username: string
                      email: string
                    update_time: string
                  page: 3887
      security: []