Chaitin Tech system/guestportalserverconfig/retrieve API

系统配置/访客门户服务配置/获取

OpenAPI Specification

chaitin-system-guestportalserverconfig-retrieve-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account system/guestportalserverconfig/retrieve API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: system/guestportalserverconfig/retrieve
  description: 系统配置/访客门户服务配置/获取
paths:
  /system/guestportalserverconfig/retrieve:
    post:
      summary: V3.2访客Portal配置查询
      deprecated: false
      description: ''
      tags:
      - system/guestportalserverconfig/retrieve
      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: 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:
                      auth_fail_redirect:
                        type: string
                      listen_port:
                        type: integer
                      auth_protocol_type:
                        type: string
                      wireless_controller_ip_filed:
                        type: string
                      valid_time:
                        type: integer
                      portal_name:
                        type: string
                      portal_web_url:
                        type: string
                      default_net_router:
                        type: string
                      auth_success_redirect:
                        type: string
                      guest_session_ttl:
                        type: integer
                      guest_password_delivery:
                        type: object
                        properties:
                          sms:
                            type: object
                            properties:
                              endpoint:
                                type: string
                              body:
                                type: string
                              method:
                                type: string
                              headers:
                                type: object
                                properties:
                                  k:
                                    type: integer
                                required:
                                - k
                            required:
                            - endpoint
                            - body
                            - method
                            - headers
                          type:
                            type: string
                        required:
                        - sms
                        - type
                      user_field_ip:
                        type: string
                      portal_protocol_version:
                        type: string
                      user_original_visit_url_field:
                        type: string
                    required:
                    - auth_fail_redirect
                    - listen_port
                    - auth_protocol_type
                    - wireless_controller_ip_filed
                    - valid_time
                    - portal_name
                    - portal_web_url
                    - default_net_router
                    - auth_success_redirect
                    - guest_session_ttl
                    - guest_password_delivery
                    - user_field_ip
                    - portal_protocol_version
                    - user_original_visit_url_field
                required:
                - code
                - msg
                - data
              example:
                code: 0
                msg: success
                data:
                  auth_fail_redirect: http://www.baid.com
                  listen_port: 50100
                  auth_protocol_type: PAP
                  wireless_controller_ip_filed: nasip2
                  valid_time: 24
                  portal_name: test
                  portal_web_url: https://192.168.89.26:8442/guest-login?companyId=eeff7c64-5070-4582-8b93-fbcc57db7771
                  default_net_router: 011ac92d-945f-4171-8e82-a18e5be04135
                  auth_success_redirect: http://www.baid.com
                  guest_session_ttl: 1
                  guest_password_delivery:
                    sms:
                      endpoint: https://1.2.3.4:5555555/qq.com
                      body: '123'
                      method: POST
                      headers:
                        k: 1
                    type: sms
                  user_field_ip: wlanuserip
                  portal_protocol_version: v1
                  user_original_visit_url_field: url
      security: []