swagger: '2.0'
info:
  description: Configuration for SWG Transaction Report  resource.
  version: 'v2'
  title: swg_user_details
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: swg_user_details
    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_details:
    get:
      tags:
        - swg_user_details
      summary: GET all swg_user_details
      operationId: getall_swg_user_details
      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:
            - rpt_sample_time
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the swg_user_details 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_details 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_details resources.
          enum:
            - yes
      responses:
        200:
          description:  for swg_user_details
          schema: 
              $ref: '#/definitions/getswg_user_detailssResponse'
        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_detailsResponse:
    type: object
    required:
      - swg_user_details
    properties:
      swg_user_details:
        $ref: '#/definitions/swg_user_details'
    title: getswg_user_detailsResponse
    example:
      swg_user_details:
        clean_url_volume: "361"
        total_domains: "45"
        __count: "0"
        url_repu_2_volume: "1580"
        total_ssl_intercepts: "54"
        risk_score: "65"
        total_domains_prev: "75"
        block_count_prev: "58"
        url_repu_level_2_count_prev: "647"
        total_bytes_in: "22453"
        clean_url_count_prev: "326"
        url_repu_level_3_count: "45"
        total_bytes: "1580364"
        total_bytes_in_prev: "64711"
        user_name_prev: "prevuser"
        total_bytes_prev: "167"
        user_name: "testuser2"
        total_requests_prev: "15811"
        url_repu_4_volume: "3647"
        total_ssl_intercepts_prev: "711"
        url_repu_level_3_count_prev: "364"
        url_repu_3_volume: "1803"
        url_repu_level_4_count: "304"
        url_repu_level_1_count: "379"
        block_count: "67"
        url_repu_level_2_count: "34"
        risk_score_prev: "71"
        total_bytes_out_prev: "1564711"
        url_repu_level_4_count_prev: "492"
        rpt_sample_time: "1580364711"
        risky_url_count: "15"
        domain_name: "test.com"
        exporter_id: "1.1.1.1"
        total_bytes_out: "37569"
        clean_url_count: "803"
        total_requests: "51397"
        url_repu_level_0_count: "804"

  getswg_user_detailssResponse:
    type: object
    required:
      - swg_user_details
    properties:
      swg_user_details:
        type: array
        items:
          $ref: '#/definitions/swg_user_details'
    title: getswg_user_detailssResponse
    example:
      swg_user_details:
        clean_url_volume: "361"
        total_domains: "45"
        __count: "0"
        url_repu_2_volume: "1580"
        total_ssl_intercepts: "54"
        risk_score: "65"
        total_domains_prev: "75"
        block_count_prev: "58"
        url_repu_level_2_count_prev: "647"
        total_bytes_in: "22453"
        clean_url_count_prev: "326"
        url_repu_level_3_count: "45"
        total_bytes: "1580364"
        total_bytes_in_prev: "64711"
        user_name_prev: "prevuser"
        total_bytes_prev: "167"
        user_name: "testuser2"
        total_requests_prev: "15811"
        url_repu_4_volume: "3647"
        total_ssl_intercepts_prev: "711"
        url_repu_level_3_count_prev: "364"
        url_repu_3_volume: "1803"
        url_repu_level_4_count: "304"
        url_repu_level_1_count: "379"
        block_count: "67"
        url_repu_level_2_count: "34"
        risk_score_prev: "71"
        total_bytes_out_prev: "1564711"
        url_repu_level_4_count_prev: "492"
        rpt_sample_time: "1580364711"
        risky_url_count: "15"
        domain_name: "test.com"
        exporter_id: "1.1.1.1"
        total_bytes_out: "37569"
        clean_url_count: "803"
        total_requests: "51397"
        url_repu_level_0_count: "804"

  swg_user_details_readwrite:
    type: object
    properties:
      clean_url_volume:
        description: "Clean URL volume"
        type: number
        format: double
      total_domains:
        description: "Domains count"
        type: number
        format: double
      __count:
        description: "count."
        type: number
        format: double
      url_repu_2_volume:
        description: "URL reputation level 2 volume"
        type: number
        format: double
      total_ssl_intercepts:
        description: "Total Intercepts"
        type: number
        format: double
      risk_score:
        description: "Risk Score"
        type: number
        format: double
      total_domains_prev:
        description: "Domains count"
        type: number
        format: double
      block_count_prev:
        description: "URL Block count Prev"
        type: number
        format: double
      url_repu_level_2_count_prev:
        description: "URL reputation level 2 count prev"
        type: number
        format: double
      total_bytes_in:
        description: "Total bytes in"
        type: number
        format: double
      clean_url_count_prev:
        description: "Clean URL count Prev"
        type: number
        format: double
      url_repu_level_3_count:
        description: "URL reputation level 3 count"
        type: number
        format: double
      total_bytes:
        description: "Total bytes"
        type: number
        format: double
      total_bytes_in_prev:
        description: "Total bytes in prev"
        type: number
        format: double
      user_name_prev:
        description: "User Name"
        type: string
        format: string
        maxLength: 255
      total_bytes_prev:
        description: "Total bytes prev"
        type: number
        format: double
      user_name:
        description: "User Name"
        type: string
        format: string
        maxLength: 255
      total_requests_prev:
        description: "Total transactions prev"
        type: number
        format: double
      url_repu_4_volume:
        description: "URL reputation level 4 volume"
        type: number
        format: double
      total_ssl_intercepts_prev:
        description: "Total Intercepts prev"
        type: number
        format: double
      url_repu_level_3_count_prev:
        description: "URL reputation level 3 count prev"
        type: number
        format: double
      url_repu_3_volume:
        description: "URL reputation level 3 volume"
        type: number
        format: double
      url_repu_level_4_count:
        description: "URL reputation level 4 count"
        type: number
        format: double
      url_repu_level_1_count:
        description: "URL reputation level 1 count"
        type: number
        format: double
      block_count:
        description: "URL Block count"
        type: number
        format: double
      url_repu_level_2_count:
        description: "URL reputation level 2 count"
        type: number
        format: double
      risk_score_prev:
        description: "Risk Score prev"
        type: number
        format: double
      total_bytes_out_prev:
        description: "Total bytes out prev"
        type: number
        format: double
      url_repu_level_4_count_prev:
        description: "URL reputation level 4 count prev"
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      risky_url_count:
        description: "Risky URL count"
        type: number
        format: double
      domain_name:
        description: "HTTP Request URL."
        type: string
        format: string
        maxLength: 2000
      exporter_id:
        description: "Exporter ID"
        type: number
        format: double
      total_bytes_out:
        description: "Total bytes out"
        type: number
        format: double
      clean_url_count:
        description: "Clean URL count"
        type: number
        format: double
      total_requests:
        description: "Total transactions"
        type: number
        format: double
      url_repu_level_0_count:
        description: "URL reputation level 0 count"
        type: number
        format: double

  swg_user_details:
    allOf:
      - $ref: '#/definitions/swg_user_details_readwrite'

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