openapi: 3.0.0
info:
  description: >-
    This is the OAS 3.0 specification for the Account Health Check API in Sophos
    Central.
  version: 1.9.0
  contact:
    name: Sophos Central APIs
    email: apis@sophos.com
    url: 'https://developer.sophos.com'
  title: Account Health Check API
tags:
  - name: Account Health Check
    description: Run Account Health check.
  - name: Account Health Scores
    description: Run Account Health scores.
  - name: Account Health Snooze
    description: Run Account Health snooze.
servers:
  - url: 'https://api-{dataRegion}.central.sophos.com/account-health-check/v1'
    description: Data region.
    variables:
      dataRegion:
        description: Data region where tenant data is stored.
        default: eu01
        enum:
          - eu01
          - eu02
          - us01
          - us03
          - ca01
          - au01
          - jp01
          - in01
          - br01
          - ae01
security:
  - bearerAuth: []
paths:
  /health-check:
    get:
      x-soph-permissions: 'endpoint-state:read OR firewall-state:read'
      summary: Account Health
      description: Get health.
      operationId: getAccountHealthCheck
      tags:
        - Account Health Check
      parameters:
        - name: X-Tenant-ID
          in: header
          description: Tenant ID.
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: checks
          description: Health checks to run.
          style: form
          explode: false
          required: false
          schema:
            type: array
            items:
              type: string
              description: Type of health check.
              enum:
                - protection
                - policy
                - exclusions
                - tamperProtection
            example:
              - protection
              - exclusions
        - in: query
          name: products
          description: Filter account health check by product.
          style: form
          explode: false
          required: false
          schema:
            type: array
            items:
              type: string
              description: Product names.
              enum:
                - endpoint
            example:
              - endpoint
              - networkDevice
      responses:
        '200':
          description: Found Account Health check.
          content:
            application/json:
              schema:
                type: object
                description: Account Health check.
                required:
                  - tenant
                properties:
                  tenant:
                    type: object
                    description: Tenant.
                    required:
                      - id
                    properties:
                      id:
                        description: The tenant's ID.
                        type: string
                        format: uuid
                      name:
                        description: The tenant's name.
                        type: string
                  endpoint:
                    type: object
                    description: Endpoint Health.
                    properties:
                      protection:
                        type: object
                        description: Endpoint Health. Null indicates an unexpected error.
                        properties:
                          computer:
                            type: object
                            description: Software check.
                            required:
                              - total
                              - notFullyProtected
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              total:
                                description: Total number of endpoints.
                                type: integer
                              notFullyProtected:
                                description: Endpoints with missing software.
                                type: integer
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          server:
                            type: object
                            description: Software check.
                            required:
                              - total
                              - notFullyProtected
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              total:
                                description: Total number of endpoints.
                                type: integer
                              notFullyProtected:
                                description: Endpoints with missing software.
                                type: integer
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                      policy:
                        type: object
                        description: >-
                          Endpoint Policy Health. Null indicates an unexpected
                          error.
                        properties:
                          computer:
                            type: object
                            description: Computer policy health for each policy type.
                            properties:
                              threat-protection:
                                type: object
                                description: Policy check for each policy type.
                                required:
                                  - total
                                  - notOnRecommended
                                  - snoozed
                                properties:
                                  score:
                                    description: The score.
                                    type: integer
                                    format: int32
                                    minimum: 0
                                    maximum: 100
                                  total:
                                    description: Number of policies of this type.
                                    type: integer
                                  notOnRecommended:
                                    description: >-
                                      Number of policies with at least one
                                      unrecommended setting.
                                    type: integer
                                  snoozed:
                                    description: Health check has been snoozed.
                                    type: boolean
                                  snoozeDetail:
                                    type: object
                                    description: Snooze information.
                                    required:
                                      - start
                                      - expired
                                      - comment
                                    properties:
                                      start:
                                        description: Time snoozed.
                                        type: string
                                        format: date-time
                                      end:
                                        description: Time the snooze was ended.
                                        type: string
                                        format: date-time
                                      expiry:
                                        description: Time the snooze expired or will expire.
                                        type: string
                                        format: date-time
                                      expired:
                                        description: Whether the snooze has expired.
                                        type: boolean
                                      comment:
                                        description: Customer comment.
                                        type: string
                                        maxLength: 750
                                  policies:
                                    description: >-
                                      List of policies with at least one
                                      unrecommended setting.
                                    type: array
                                    items:
                                      type: object
                                      description: Policy check.
                                      required:
                                        - id
                                        - name
                                        - notOnRecommended
                                        - lockedByManagingAccount
                                      properties:
                                        id:
                                          description: Policy ID.
                                          type: string
                                          format: uuid
                                        name:
                                          description: Policy name.
                                          type: string
                                        lockedByManagingAccount:
                                          description: >-
                                            Whether the policy is managed by a
                                            partner or organization, 'true' means
                                            yes.
                                          type: boolean
                                        notOnRecommended:
                                          description: Number of unrecommended settings.
                                          type: integer
                          server:
                            type: object
                            description: Server policy health for each policy type.
                            properties:
                              server-threat-protection:
                                type: object
                                description: Policy check for each policy type.
                                required:
                                  - total
                                  - notOnRecommended
                                  - snoozed
                                properties:
                                  score:
                                    description: The score.
                                    type: integer
                                    format: int32
                                    minimum: 0
                                    maximum: 100
                                  total:
                                    description: Number of policies of this type.
                                    type: integer
                                  notOnRecommended:
                                    description: >-
                                      Number of policies with at least one
                                      unrecommended setting.
                                    type: integer
                                  snoozed:
                                    description: Health check has been snoozed.
                                    type: boolean
                                  snoozeDetail:
                                    type: object
                                    description: Snooze information.
                                    required:
                                      - start
                                      - expired
                                      - comment
                                    properties:
                                      start:
                                        description: Time snoozed.
                                        type: string
                                        format: date-time
                                      end:
                                        description: Time the snooze was ended.
                                        type: string
                                        format: date-time
                                      expiry:
                                        description: Time the snooze expired or will expire.
                                        type: string
                                        format: date-time
                                      expired:
                                        description: Whether the snooze has expired.
                                        type: boolean
                                      comment:
                                        description: Customer comment.
                                        type: string
                                        maxLength: 750
                                  policies:
                                    description: >-
                                      List of policies with at least one
                                      unrecommended setting.
                                    type: array
                                    items:
                                      type: object
                                      description: Policy check.
                                      required:
                                        - id
                                        - name
                                        - notOnRecommended
                                        - lockedByManagingAccount
                                      properties:
                                        id:
                                          description: Policy ID.
                                          type: string
                                          format: uuid
                                        name:
                                          description: Policy name.
                                          type: string
                                        lockedByManagingAccount:
                                          description: >-
                                            Whether the policy is managed by a
                                            partner or organization, 'true' means
                                            yes.
                                          type: boolean
                                        notOnRecommended:
                                          description: Number of unrecommended settings.
                                          type: integer
                      exclusions:
                        type: object
                        description: >-
                          Endpoint Exclusions Health. Null indicates an
                          unexpected error.
                        properties:
                          policy:
                            type: object
                            description: Endpoint Policy Exclusions Health.
                            required:
                              - computer
                              - server
                            properties:
                              computer:
                                type: object
                                description: Policy exclusions check.
                                required:
                                  - total
                                  - numberOfSecurityRisks
                                  - snoozed
                                properties:
                                  score:
                                    description: The score.
                                    type: integer
                                    format: int32
                                    minimum: 0
                                    maximum: 100
                                  total:
                                    description: Total number of exclusions.
                                    type: integer
                                  numberOfSecurityRisks:
                                    description: Exclusions that may be risky.
                                    type: integer
                                  snoozed:
                                    description: Health check has been snoozed.
                                    type: boolean
                                  snoozeDetail:
                                    type: object
                                    description: Snooze information.
                                    required:
                                      - start
                                      - expired
                                      - comment
                                    properties:
                                      start:
                                        description: Time snoozed.
                                        type: string
                                        format: date-time
                                      end:
                                        description: Time the snooze was ended.
                                        type: string
                                        format: date-time
                                      expiry:
                                        description: Time the snooze expired or will expire.
                                        type: string
                                        format: date-time
                                      expired:
                                        description: Whether the snooze has expired.
                                        type: boolean
                                      comment:
                                        description: Customer comment.
                                        type: string
                                        maxLength: 750
                                  exclusions:
                                    description: List of exclusions that may be risky.
                                    type: array
                                    items:
                                      type: object
                                      description: Policy exclusions check.
                                      required:
                                        - policyId
                                        - policyName
                                        - lockedByManagingAccount
                                      properties:
                                        policyId:
                                          description: Policy ID.
                                          type: string
                                          format: uuid
                                        policyName:
                                          description: Policy name.
                                          type: string
                                        lockedByManagingAccount:
                                          description: >-
                                            Whether the policy is managed by a
                                            partner or organization, 'true' means
                                            yes.
                                          type: boolean
                                        snoozeComment:
                                          description: Snooze comment.
                                          type: string
                                          maxLength: 750
                                        scanningExclusions:
                                          description: List of scanning exclusions.
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - value
                                              - type
                                              - scanMode
                                            properties:
                                              value:
                                                description: Exclusion value.
                                                type: string
                                              type:
                                                type: string
                                                description: Type of scan excluded.
                                                enum:
                                                  - path
                                                  - posixPath
                                                  - virtualPath
                                                  - process
                                                  - web
                                                  - pua
                                                  - detectedExploit
                                                  - amsi
                                                  - behavioral
                                                  - journalHashingProcess
                                                  - journalHashingPath
                                              scanMode:
                                                type: string
                                                description: Mode of scan excluded.
                                                enum:
                                                  - onDemand
                                                  - onAccess
                                                  - onDemandAndOnAccess
                                              reasonCode:
                                                type: string
                                                description: >-
                                                  Reason for scanning exclusion being
                                                  flagged as an issue.
                                                enum:
                                                  - allFilesWithExecutableExtension
                                                  - commonExecutable
                                                  - entireDrive
                                                  - usesWindowsPathVariables
                                                  - usesWindowsSystemDirectoriesViaSyspath
                                                  - windowsDirectories
                                                  - windowsStartupDirectory
                                                  - windowsSystemDirectories
                                                  - windowsSystemTools
                              server:
                                type: object
                                description: Policy exclusions check.
                                required:
                                  - total
                                  - numberOfSecurityRisks
                                  - snoozed
                                properties:
                                  score:
                                    description: The score.
                                    type: integer
                                    format: int32
                                    minimum: 0
                                    maximum: 100
                                  total:
                                    description: Total number of exclusions.
                                    type: integer
                                  numberOfSecurityRisks:
                                    description: Exclusions that may be risky.
                                    type: integer
                                  snoozed:
                                    description: Health check has been snoozed.
                                    type: boolean
                                  snoozeDetail:
                                    type: object
                                    description: Snooze information.
                                    required:
                                      - start
                                      - expired
                                      - comment
                                    properties:
                                      start:
                                        description: Time snoozed.
                                        type: string
                                        format: date-time
                                      end:
                                        description: Time the snooze was ended.
                                        type: string
                                        format: date-time
                                      expiry:
                                        description: Time the snooze expired or will expire.
                                        type: string
                                        format: date-time
                                      expired:
                                        description: Whether the snooze has expired.
                                        type: boolean
                                      comment:
                                        description: Customer comment.
                                        type: string
                                        maxLength: 750
                                  exclusions:
                                    description: List of exclusions that may be risky.
                                    type: array
                                    items:
                                      type: object
                                      description: Policy exclusions check.
                                      required:
                                        - policyId
                                        - policyName
                                        - lockedByManagingAccount
                                      properties:
                                        policyId:
                                          description: Policy ID.
                                          type: string
                                          format: uuid
                                        policyName:
                                          description: Policy name.
                                          type: string
                                        lockedByManagingAccount:
                                          description: >-
                                            Whether the policy is managed by a
                                            partner or organization, 'true' means
                                            yes.
                                          type: boolean
                                        snoozeComment:
                                          description: Snooze comment.
                                          type: string
                                          maxLength: 750
                                        scanningExclusions:
                                          description: List of scanning exclusions.
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - value
                                              - type
                                              - scanMode
                                            properties:
                                              value:
                                                description: Exclusion value.
                                                type: string
                                              type:
                                                type: string
                                                description: Type of scan excluded.
                                                enum:
                                                  - path
                                                  - posixPath
                                                  - virtualPath
                                                  - process
                                                  - web
                                                  - pua
                                                  - detectedExploit
                                                  - amsi
                                                  - behavioral
                                                  - journalHashingProcess
                                                  - journalHashingPath
                                              scanMode:
                                                type: string
                                                description: Mode of scan excluded.
                                                enum:
                                                  - onDemand
                                                  - onAccess
                                                  - onDemandAndOnAccess
                                              reasonCode:
                                                type: string
                                                description: >-
                                                  Reason for scanning exclusion being
                                                  flagged as an issue.
                                                enum:
                                                  - allFilesWithExecutableExtension
                                                  - commonExecutable
                                                  - entireDrive
                                                  - usesWindowsPathVariables
                                                  - usesWindowsSystemDirectoriesViaSyspath
                                                  - windowsDirectories
                                                  - windowsStartupDirectory
                                                  - windowsSystemDirectories
                                                  - windowsSystemTools
                          global:
                            type: object
                            description: Global exclusions check.
                            required:
                              - numberOfSecurityRisks
                              - lockedByManagingAccount
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              numberOfSecurityRisks:
                                description: Exclusions that may be risky.
                                type: integer
                              lockedByManagingAccount:
                                description: >-
                                  Whether the settings are managed by a partner
                                  or organization, 'true' means yes.
                                type: boolean
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                              scanningExclusions:
                                description: List of scanning exclusions.
                                type: array
                                items:
                                  type: object
                                  required:
                                    - id
                                    - value
                                    - type
                                    - scanMode
                                  properties:
                                    id:
                                      description: Unique ID for the scanning exclusion.
                                      type: string
                                      format: uuid
                                    value:
                                      description: Exclusion value.
                                      type: string
                                    type:
                                      type: string
                                      description: Type of scan excluded.
                                      enum:
                                        - path
                                        - posixPath
                                        - virtualPath
                                        - process
                                        - web
                                        - pua
                                        - detectedExploit
                                        - amsi
                                        - behavioral
                                        - journalHashingProcess
                                        - journalHashingPath
                                    scanMode:
                                      type: string
                                      description: Mode of scan excluded.
                                      enum:
                                        - onDemand
                                        - onAccess
                                        - onDemandAndOnAccess
                                    reasonCode:
                                      type: string
                                      description: >-
                                        Reason for scanning exclusion being
                                        flagged as an issue.
                                      enum:
                                        - allFilesWithExecutableExtension
                                        - commonExecutable
                                        - entireDrive
                                        - usesWindowsPathVariables
                                        - usesWindowsSystemDirectoriesViaSyspath
                                        - windowsDirectories
                                        - windowsStartupDirectory
                                        - windowsSystemDirectories
                                        - windowsSystemTools
                      tamperProtection:
                        type: object
                        description: >-
                          Tamper Protection Health. Null indicates an unexpected
                          error.
                        properties:
                          computer:
                            type: object
                            description: Tamper Protection check for each device.
                            required:
                              - total
                              - disabled
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              total:
                                description: Total number of endpoints.
                                type: integer
                              disabled:
                                description: >-
                                  Number of endpoints with Tamper Protection
                                  turned off.
                                type: integer
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          server:
                            type: object
                            description: Tamper Protection check for each device.
                            required:
                              - total
                              - disabled
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              total:
                                description: Total number of endpoints.
                                type: integer
                              disabled:
                                description: >-
                                  Number of endpoints with Tamper Protection
                                  turned off.
                                type: integer
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          globalDetail:
                            type: object
                            description: Global Tamper Protection check.
                            required:
                              - enabled
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              enabled:
                                description: Tamper Protection is turned on globally.
                                type: boolean
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          global:
                            description: >-
                              Tamper Protection is turned on globally. This is
                              deprecated, use globalDetail/enabled instead.
                            type: boolean
                  networkDevice:
                    type: object
                    description: Network device health.
                    properties:
                      firewall:
                        type: object
                        description: Network device Firewall health.
                        properties:
                          firewallAutomaticBackup:
                            type: object
                            description: Backup check for each firewall.
                            required:
                              - total
                              - snoozed
                            properties:
                              score:
                                description: The score.
                                type: integer
                                format: int32
                                minimum: 0
                                maximum: 100
                              total:
                                description: >-
                                  Total Number of eligible firewalls of the
                                  tenant.
                                type: integer
                              notOnRecommended:
                                description: >-
                                  Total Number of firewall for which backup not
                                  done.
                                type: integer
                              snoozed:
                                description: Health check has been snoozed.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                              schedule:
                                type: object
                                description: Backup schedule details for the tenant.
                                required:
                                  - frequency
                                properties:
                                  frequency:
                                    type: string
                                    description: Firewall backup frequency.
                                    enum:
                                      - never
                                      - daily
                                      - weekly
                                      - monthly
                                  day:
                                    description: Day number for the frequency.
                                    type: integer
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
  /scores/regional:
    get:
      x-soph-permissions: 'endpoint-state:read OR firewall-state:read'
      summary: Score comparisons
      description: Get health score for comparison to other organizations in your region.
      operationId: getRegionalScores
      tags:
        - Account Health Scores
      parameters:
        - name: X-Tenant-ID
          in: header
          description: Tenant ID.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Account Health Check scores by region.
          content:
            application/json:
              schema:
                type: object
                description: Account Health Check scores by region.
                required:
                  - bands
                properties:
                  bands:
                    description: List of bands.
                    type: array
                    items:
                      type: object
                      description: Score Band.
                      properties:
                        lowerBound:
                          description: Lower tenant size bound.
                          type: integer
                        upperBound:
                          description: Upper tenant size bound.
                          type: integer
                        endpoint:
                          type: object
                          description: Endpoint.
                          properties:
                            protectionComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            protectionServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            policyThreatProtectionComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            policyThreatProtectionServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            exclusionsGlobalScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            exclusionsComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            exclusionsServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            tamperProtectionGlobalScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            tamperProtectionComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            tamperProtectionServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
  /scores/historical:
    get:
      x-soph-permissions: 'endpoint-state:read OR firewall-state:read'
      summary: Historical Score
      description: Get historical health scores.
      operationId: getHistoricalScores
      tags:
        - Account Health Scores
      parameters:
        - name: X-Tenant-ID
          in: header
          description: Tenant ID.
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: startDate
          description: Start date (the range between startDate and endDate is inclusive).
          schema:
            type: string
            format: date
          example: '2022-12-25T00:00:00.000Z'
        - in: query
          name: endDate
          description: End date (the range between startDate and endDate is inclusive).
          schema:
            type: string
            format: date
          example: '2022-12-25T00:00:00.000Z'
      responses:
        '200':
          description: Historical scores.
          content:
            application/json:
              schema:
                type: object
                description: Account Health historical scores.
                required:
                  - tenant
                  - datapoints
                properties:
                  tenant:
                    type: object
                    description: Tenant.
                    required:
                      - id
                    properties:
                      id:
                        description: The tenant's ID.
                        type: string
                        format: uuid
                      name:
                        description: The tenant's name.
                        type: string
                  datapoints:
                    description: List of datapoints.
                    type: array
                    items:
                      type: object
                      description: Score Datapoint.
                      properties:
                        date:
                          description: The date.
                          type: string
                          format: date
                        computerTotal:
                          description: Number of computers.
                          type: integer
                        serverTotal:
                          description: Number of servers.
                          type: integer
                        endpoint:
                          type: object
                          description: Endpoint.
                          properties:
                            protectionComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            protectionServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            policyThreatProtectionComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            policyThreatProtectionServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            exclusionsGlobalScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            exclusionsComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            exclusionsServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            tamperProtectionGlobalScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            tamperProtectionComputerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                            tamperProtectionServerScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
                        networkDevice:
                          type: object
                          description: Network Device.
                          properties:
                            firewallBackupScore:
                              description: The score.
                              type: integer
                              format: int32
                              minimum: 0
                              maximum: 100
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
  /snooze:
    post:
      x-soph-permissions: >-
        endpoint-policy:update OR endpoint-state:update OR
        endpoint-server:update OR endpoint-computer:update OR
        firewall-state:update
      summary: Snooze
      description: Snooze reminders for account health issues for a customer.
      operationId: postSnooze
      tags:
        - Account Health Snooze
      parameters:
        - name: X-Tenant-ID
          in: header
          description: Tenant ID.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Snooze request.
              properties:
                endpoint:
                  type: object
                  description: Snooze request.
                  properties:
                    policy:
                      type: object
                      description: Configure snooze request.
                      properties:
                        computer:
                          type: array
                          description: Policy types to snooze.
                          items:
                            type: object
                            description: Snooze request information.
                            required:
                              - snoozed
                              - policyType
                            properties:
                              policyType:
                                description: Policy type.
                                type: string
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze request information.
                                required:
                                  - comment
                                properties:
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                        server:
                          type: array
                          description: Policy types to snooze.
                          items:
                            type: object
                            description: Snooze request information.
                            required:
                              - snoozed
                              - policyType
                            properties:
                              policyType:
                                description: Policy type.
                                type: string
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze request information.
                                required:
                                  - comment
                                properties:
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                    exclusions:
                      type: object
                      description: Configure snooze request.
                      properties:
                        policy:
                          type: object
                          description: Configure snooze request.
                          properties:
                            computer:
                              type: array
                              description: Policy types to snooze.
                              items:
                                type: object
                                description: Snooze request information.
                                required:
                                  - snoozed
                                  - policyType
                                properties:
                                  policyType:
                                    description: Policy type.
                                    type: string
                                  snoozed:
                                    description: Whether snoozed by a user.
                                    type: boolean
                                  snoozeDetail:
                                    type: object
                                    description: Snooze request information.
                                    required:
                                      - comment
                                    properties:
                                      comment:
                                        description: Customer comment.
                                        type: string
                                        maxLength: 750
                                  exclusions:
                                    description: List of scanning exclusions.
                                    type: array
                                    items:
                                      type: object
                                      description: Snooze comment.
                                      required:
                                        - id
                                        - snoozeComment
                                      properties:
                                        id:
                                          description: Policy UUID.
                                          type: string
                                          format: uuid
                                        snoozeComment:
                                          description: Snooze comment.
                                          type: string
                                          maxLength: 750
                            server:
                              type: array
                              description: Policy types to snooze.
                              items:
                                type: object
                                description: Snooze request information.
                                required:
                                  - snoozed
                                  - policyType
                                properties:
                                  policyType:
                                    description: Policy type.
                                    type: string
                                  snoozed:
                                    description: Whether snoozed by a user.
                                    type: boolean
                                  snoozeDetail:
                                    type: object
                                    description: Snooze request information.
                                    required:
                                      - comment
                                    properties:
                                      comment:
                                        description: Customer comment.
                                        type: string
                                        maxLength: 750
                                  exclusions:
                                    description: List of scanning exclusions.
                                    type: array
                                    items:
                                      type: object
                                      description: Snooze comment.
                                      required:
                                        - id
                                        - snoozeComment
                                      properties:
                                        id:
                                          description: Policy UUID.
                                          type: string
                                          format: uuid
                                        snoozeComment:
                                          description: Snooze comment.
                                          type: string
                                          maxLength: 750
                        global:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
                    tamperProtection:
                      type: object
                      description: Configure snooze request.
                      properties:
                        computer:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
                        server:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
                        global:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
                    protection:
                      type: object
                      description: Configure snooze request.
                      properties:
                        computer:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
                        server:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
                networkDevice:
                  type: object
                  description: Snooze request.
                  properties:
                    firewall:
                      type: object
                      description: Configure snooze request.
                      properties:
                        firewallAutomaticBackup:
                          type: object
                          description: Snooze request information.
                          required:
                            - snoozed
                          properties:
                            snoozed:
                              description: Whether snoozed by a user.
                              type: boolean
                            snoozeDetail:
                              type: object
                              description: Snooze request information.
                              required:
                                - comment
                              properties:
                                comment:
                                  description: Customer comment.
                                  type: string
                                  maxLength: 750
      responses:
        '200':
          description: Snooze accepted.
          content:
            application/json:
              schema:
                type: object
                description: Snooze response.
                properties:
                  endpoint:
                    type: object
                    description: Snooze response.
                    properties:
                      policy:
                        type: object
                        description: Snooze response.
                        properties:
                          computer:
                            type: array
                            description: Policy types with snooze information.
                            items:
                              type: object
                              description: Snooze response information.
                              required:
                                - snoozed
                                - policyType
                              properties:
                                policyType:
                                  description: Policy type.
                                  type: string
                                snoozed:
                                  description: Whether snoozed by a user.
                                  type: boolean
                                snoozeDetail:
                                  type: object
                                  description: Snooze information.
                                  required:
                                    - start
                                    - expired
                                    - comment
                                  properties:
                                    start:
                                      description: Time snoozed.
                                      type: string
                                      format: date-time
                                    end:
                                      description: Time the snooze was ended.
                                      type: string
                                      format: date-time
                                    expiry:
                                      description: Time the snooze expired or will expire.
                                      type: string
                                      format: date-time
                                    expired:
                                      description: Whether the snooze has expired.
                                      type: boolean
                                    comment:
                                      description: Customer comment.
                                      type: string
                                      maxLength: 750
                          server:
                            type: array
                            description: Policy types with snooze information.
                            items:
                              type: object
                              description: Snooze response information.
                              required:
                                - snoozed
                                - policyType
                              properties:
                                policyType:
                                  description: Policy type.
                                  type: string
                                snoozed:
                                  description: Whether snoozed by a user.
                                  type: boolean
                                snoozeDetail:
                                  type: object
                                  description: Snooze information.
                                  required:
                                    - start
                                    - expired
                                    - comment
                                  properties:
                                    start:
                                      description: Time snoozed.
                                      type: string
                                      format: date-time
                                    end:
                                      description: Time the snooze was ended.
                                      type: string
                                      format: date-time
                                    expiry:
                                      description: Time the snooze expired or will expire.
                                      type: string
                                      format: date-time
                                    expired:
                                      description: Whether the snooze has expired.
                                      type: boolean
                                    comment:
                                      description: Customer comment.
                                      type: string
                                      maxLength: 750
                      exclusions:
                        type: object
                        description: Snooze response.
                        properties:
                          policy:
                            type: object
                            description: Snooze response.
                            properties:
                              computer:
                                type: array
                                description: Policy types with snooze information.
                                items:
                                  type: object
                                  description: Snooze response information.
                                  required:
                                    - snoozed
                                    - policyType
                                  properties:
                                    policyType:
                                      description: Policy type.
                                      type: string
                                    snoozed:
                                      description: Whether snoozed by a user.
                                      type: boolean
                                    snoozeDetail:
                                      type: object
                                      description: Snooze information.
                                      required:
                                        - start
                                        - expired
                                        - comment
                                      properties:
                                        start:
                                          description: Time snoozed.
                                          type: string
                                          format: date-time
                                        end:
                                          description: Time the snooze was ended.
                                          type: string
                                          format: date-time
                                        expiry:
                                          description: Time the snooze expired or will expire.
                                          type: string
                                          format: date-time
                                        expired:
                                          description: Whether the snooze has expired.
                                          type: boolean
                                        comment:
                                          description: Customer comment.
                                          type: string
                                          maxLength: 750
                                    exclusions:
                                      description: List of policies.
                                      type: array
                                      items:
                                        type: object
                                        description: Snooze comment.
                                        required:
                                          - id
                                          - snoozeComment
                                        properties:
                                          id:
                                            description: Policy UUID.
                                            type: string
                                            format: uuid
                                          snoozeComment:
                                            description: Snooze comment.
                                            type: string
                                            maxLength: 750
                              server:
                                type: array
                                description: Policy types with snooze information.
                                items:
                                  type: object
                                  description: Snooze response information.
                                  required:
                                    - snoozed
                                    - policyType
                                  properties:
                                    policyType:
                                      description: Policy type.
                                      type: string
                                    snoozed:
                                      description: Whether snoozed by a user.
                                      type: boolean
                                    snoozeDetail:
                                      type: object
                                      description: Snooze information.
                                      required:
                                        - start
                                        - expired
                                        - comment
                                      properties:
                                        start:
                                          description: Time snoozed.
                                          type: string
                                          format: date-time
                                        end:
                                          description: Time the snooze was ended.
                                          type: string
                                          format: date-time
                                        expiry:
                                          description: Time the snooze expired or will expire.
                                          type: string
                                          format: date-time
                                        expired:
                                          description: Whether the snooze has expired.
                                          type: boolean
                                        comment:
                                          description: Customer comment.
                                          type: string
                                          maxLength: 750
                                    exclusions:
                                      description: List of policies.
                                      type: array
                                      items:
                                        type: object
                                        description: Snooze comment.
                                        required:
                                          - id
                                          - snoozeComment
                                        properties:
                                          id:
                                            description: Policy UUID.
                                            type: string
                                            format: uuid
                                          snoozeComment:
                                            description: Snooze comment.
                                            type: string
                                            maxLength: 750
                          global:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                      tamperProtection:
                        type: object
                        description: Snooze response.
                        properties:
                          computer:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          server:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          global:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                      protection:
                        type: object
                        description: Snooze response.
                        properties:
                          computer:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                          server:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
                  networkDevice:
                    type: object
                    description: Snooze response.
                    properties:
                      firewall:
                        type: object
                        description: Snooze response.
                        properties:
                          firewallAutomaticBackup:
                            type: object
                            description: Snooze response information.
                            required:
                              - snoozed
                            properties:
                              snoozed:
                                description: Whether snoozed by a user.
                                type: boolean
                              snoozeDetail:
                                type: object
                                description: Snooze information.
                                required:
                                  - start
                                  - expired
                                  - comment
                                properties:
                                  start:
                                    description: Time snoozed.
                                    type: string
                                    format: date-time
                                  end:
                                    description: Time the snooze was ended.
                                    type: string
                                    format: date-time
                                  expiry:
                                    description: Time the snooze expired or will expire.
                                    type: string
                                    format: date-time
                                  expired:
                                    description: Whether the snooze has expired.
                                    type: boolean
                                  comment:
                                    description: Customer comment.
                                    type: string
                                    maxLength: 750
        '400':
          description: Invalid or missing request body.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  correlationId:
                    type: string
                    format: uuid
                  code:
                    type: string
                  createdAt:
                    type: string
                    format: datetime
                  requestId:
                    type: string
                    format: uuid
                  docUrl:
                    type: string
                    format: uri
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT