swagger: '2.0'
info:
  description: Configuration for Af report for VPN Error details resource.
  version: 'v2'
  title: vpn_error_details
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: vpn_error_details
    description: Af report for VPN Error details
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/vpn_error_details:
    get:
      tags:
        - vpn_error_details
      summary: GET all vpn_error_details
      operationId: getall_vpn_error_details
      description: Af Report for VPN Error Details ...
      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: cr_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate cr is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: report_start_time
          type: string
          required: false
          description: Use this query-parameter to specify the start time from which the summary for report is considered
        - in: query
          name: report_end_time
          type: string
          required: false
          description: Use this query-parameter to specify the end time until where summary for report is considered
        - in: query
          name: sla_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate sla is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the vpn_error_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 vpn_error_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 vpn_error_details resources.
          enum:
            - yes
      responses:
        200:
          description:  for vpn_error_details
          schema: 
              $ref: '#/definitions/getvpn_error_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:
  getvpn_error_detailsResponse:
    type: object
    required:
      - vpn_error_details
    properties:
      vpn_error_details:
        $ref: '#/definitions/vpn_error_details'
    title: getvpn_error_detailsResponse
    example:
      vpn_error_details:
        cs_vserver_name: "VPN_service-gw"
        city_name: "Bengaluru"
        country_name: "India"
        auth_type: "Local Auth"
        error_code: "0"
        username: "user123"
        client_ip_address: "1.1.1.1"
        vpn_fqdn: "vpn_service-gw.citrix.com"
        error_description: "EPA Pre-Auth check failure"
        ad_server_ip_address: "1.1.1.1"
        next_factor_policy_label: "policy_1.1.1.1"
        vpn_server_name: "VPN_service-gw"
        server_ip_address: "1.1.1.1"
        error_count: "0"
        policy_name: "preauth_pol1"
        __count: "0"
        flag: "0"
        sso_method_type: "Basic"
        id: "4c738995-a4f9-441d-a938-720391b1ed43"
        region_name: "Karnataka"
        error_time: "0"
        resource_name: "Resource-A"
        req_url: "test.com"
        ica_device_ip_address: "1.1.1.1"
        authentication_state: "0th Factor"
        epa_method_type: "Pre Auth EPA"
        sta_ip: "1.1.1.1"
        epa_expression: "client.os(macos) exists"
        current_factor_policy_label: "policy_1.1.1.1"

  getvpn_error_detailssResponse:
    type: object
    required:
      - vpn_error_details
    properties:
      vpn_error_details:
        type: array
        items:
          $ref: '#/definitions/vpn_error_details'
    title: getvpn_error_detailssResponse
    example:
      vpn_error_details:
        cs_vserver_name: "VPN_service-gw"
        city_name: "Bengaluru"
        country_name: "India"
        auth_type: "Local Auth"
        error_code: "0"
        username: "user123"
        client_ip_address: "1.1.1.1"
        vpn_fqdn: "vpn_service-gw.citrix.com"
        error_description: "EPA Pre-Auth check failure"
        ad_server_ip_address: "1.1.1.1"
        next_factor_policy_label: "policy_1.1.1.1"
        vpn_server_name: "VPN_service-gw"
        server_ip_address: "1.1.1.1"
        error_count: "0"
        policy_name: "preauth_pol1"
        __count: "0"
        flag: "0"
        sso_method_type: "Basic"
        id: "4c738995-a4f9-441d-a938-720391b1ed43"
        region_name: "Karnataka"
        error_time: "0"
        resource_name: "Resource-A"
        req_url: "test.com"
        ica_device_ip_address: "1.1.1.1"
        authentication_state: "0th Factor"
        epa_method_type: "Pre Auth EPA"
        sta_ip: "1.1.1.1"
        epa_expression: "client.os(macos) exists"
        current_factor_policy_label: "policy_1.1.1.1"

  vpn_error_details_readwrite:
    type: object
    properties:
      cs_vserver_name:
        description: "CS Server Name."
        type: string
        format: string
        maxLength: 128
      city_name:
        description: "City"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      country_name:
        description: "Country"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      auth_type:
        description: "Authentication Type"
        type: string
        format: string
        maxLength: 128
      error_code:
        description: "Error Code"
        type: number
        format: double
      username:
        description: "User Name"
        type: string
        format: string
        maxLength: 128
      vpn_fqdn:
        description: "VPN FQDN"
        type: string
        format: string
        maxLength: 128
      error_description:
        description: "STA Validation Failure Counts."
        type: string
        format: string
        maxLength: 1024
      ad_server_ip_address:
        description: "Active Directory Server IP Address"
        type: string
        format: ipaddress
        maxLength: 32
      next_factor_policy_label:
        description: "next factor policy label"
        type: string
        format: string
        maxLength: 255
      vpn_server_name:
        description: "VPN Server Name."
        type: string
        format: string
        maxLength: 128
      server_ip_address:
        description: "Server IP Address."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      error_count:
        description: "Error Code"
        type: number
        format: double
      policy_name:
        description: "EPA Policy Name"
        type: string
        format: string
        maxLength: 1024
      __count:
        description: "count."
        type: number
        format: double
      flag:
        description: "Flag"
        type: number
        format: double
      sso_method_type:
        description: "SSO Method Type"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      id:
        description: "Id is not dicided yet"
        type: string
        format: uuid
        minLength: 1
        maxLength: 64
      region_name:
        description: "Region"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      error_time:
        description: "Flag"
        type: number
        format: double
      resource_name:
        description: "Resource Name"
        type: string
        format: string
        maxLength: 128
      req_url:
        description: "req_url"
        type: string
        format: string
        maxLength: 255
      ica_device_ip_address:
        description: "ICA Device IP Address."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      authentication_state:
        description: "Authentication State"
        type: string
        format: string
        maxLength: 128
      sta_ip:
        description: "STA Server IP."
        type: string
        format: ipaddress
        maxLength: 128
      epa_expression:
        description: "EPA Expression"
        type: string
        format: string
        maxLength: 255
      current_factor_policy_label:
        description: "current factor policy label"
        type: string
        format: string
        maxLength: 255

  vpn_error_details:
    allOf:
      - $ref: '#/definitions/vpn_error_details_readwrite'

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