swagger: '2.0'
info:
  description: Configuration for SWG Transaction Report resource.
  version: 'v2'
  title: swg_user_summary
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: swg_user_summary
    description: SWG Transaction Report
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/swg_user_summary:
    get:
      tags:
        - swg_user_summary
      summary: GET all swg_user_summary
      operationId: getall_swg_user_summary
      description: Af Report for Top URL being Count Managed by this AF Collector
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: args
          type: string
          required: false
          description: "Use this query-parameter to specify arguments.Example:  property-name1:property-value1 "
        - in: query
          name: duration
          type: string
          required: true
          description: "Duration "
          enum:
            - last_1_hour
            - last_1_day
            - last_1_week
            - last_1_month
        - in: query
          name: asc
          type: string
          required: false
          description: Use this query-parameter to specify whether the results should be in ascending order or not
          enum:
            - yes
            - no
        - in: query
          name: order_by
          type: string
          required: false
          description: Use this query-parameter to get the result that is ordered by the given property
          enum:
            - rpt_sample_time
        - in: query
          name: group_by
          type: string
          required: false
          description: Use this query-parameter to get the result that is grouped by according total_not_attempted the given property
          enum:
            - url_reputation, user_agent, rpt_sample_time, url_group_category
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the swg_user_summary resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the swg_user_summary resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of swg_user_summary resources.
          enum:
            - yes
      responses:
        200:
          description:  for swg_user_summary
          schema: 
              $ref: '#/definitions/getswg_user_summarysResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getswg_user_summaryResponse:
    type: object
    required:
      - swg_user_summary
    properties:
      swg_user_summary:
        $ref: '#/definitions/swg_user_summary'
    title: getswg_user_summaryResponse
    example:
      swg_user_summary:
        total_ssl_intercepts_prev: "0"
        protocol: "HTTP"
        __count: "0"
        operating_system: "Windows"
        total_ssl_intercepts: "0"
        total_bytes_in: "270030"
        url_group_category: "Others"
        total_bytes_out_prev: "195452"
        user_agent: "Unknown"
        total_bytes: "270030"
        rpt_sample_time: "1580364711"
        total_bytes_in_prev: "37729"
        port: "80"
        user_count_prev: "6"
        total_bytes_prev: "233181"
        user_name: "NetScaler123"
        exporter_id: "1.1.1.1"
        total_bytes_out: "195452"
        url_reputation: "-1"
        total_requests_prev: "233181"
        user_count: "6"
        total_requests: "564"

  getswg_user_summarysResponse:
    type: object
    required:
      - swg_user_summary
    properties:
      swg_user_summary:
        type: array
        items:
          $ref: '#/definitions/swg_user_summary'
    title: getswg_user_summarysResponse
    example:
      swg_user_summary:
        total_ssl_intercepts_prev: "0"
        protocol: "HTTP"
        __count: "0"
        operating_system: "Windows"
        total_ssl_intercepts: "0"
        total_bytes_in: "270030"
        url_group_category: "Others"
        total_bytes_out_prev: "195452"
        user_agent: "Unknown"
        total_bytes: "270030"
        rpt_sample_time: "1580364711"
        total_bytes_in_prev: "37729"
        port: "80"
        user_count_prev: "6"
        total_bytes_prev: "233181"
        user_name: "NetScaler123"
        exporter_id: "1.1.1.1"
        total_bytes_out: "195452"
        url_reputation: "-1"
        total_requests_prev: "233181"
        user_count: "6"
        total_requests: "564"

  swg_user_summary_readwrite:
    type: object
    properties:
      total_ssl_intercepts_prev:
        description: "Total Intercepts"
        type: number
        format: double
      protocol:
        description: "protocol used"
        type: string
        format: string
      __count:
        description: "count."
        type: number
        format: double
      operating_system:
        description: "Client Operating System Name."
        type: string
        format: string
        maxLength: 255
      total_ssl_intercepts:
        description: "Total Intercepts"
        type: number
        format: double
      total_bytes_in:
        description: "Total bytes in"
        type: number
        format: double
      url_group_category:
        description: "URL Group Category"
        type: string
        format: string
      total_bytes_out_prev:
        description: "Total bytes out"
        type: number
        format: double
      user_agent:
        description: "User Agent Name."
        type: string
        format: string
        maxLength: 255
      total_bytes:
        description: "Total bytes "
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      total_bytes_in_prev:
        description: "Total bytes in"
        type: number
        format: double
      port:
        description: "protocol used"
        type: number
        format: double
      user_count_prev:
        description: "User Count Prev"
        type: number
        format: double
      total_bytes_prev:
        description: "Total bytes out"
        type: number
        format: double
      user_name:
        description: "User Name"
        type: string
        format: string
        maxLength: 255
      exporter_id:
        description: "Exporter ID"
        type: number
        format: double
      total_bytes_out:
        description: "Total bytes out"
        type: number
        format: double
      url_reputation:
        description: "URL reputation"
        type: number
        format: double
      total_requests_prev:
        description: "Total transactions"
        type: number
        format: double
      user_count:
        description: "User Count"
        type: number
        format: double
      total_requests:
        description: "Total transactions"
        type: number
        format: double

  swg_user_summary:
    allOf:
      - $ref: '#/definitions/swg_user_summary_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
