openapi: 3.0.3
info:
  title: ZAP accessControl forcedUser API
  description: The HTTP API for controlling and accessing ZAP.
  contact:
    name: ZAP User Group
    url: https://groups.google.com/group/zaproxy-users
    email: zaproxy-users@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.16.1
servers:
- url: http://zap
  description: The URL while proxying through ZAP.
- url: http://{address}:{port}
  description: The URL of a Local Proxy of ZAP.
  variables:
    address:
      description: The address ZAP is listening on.
      default: 127.0.0.1
    port:
      description: The port ZAP is bound to.
      default: '8080'
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: forcedUser
paths:
  /JSON/forcedUser/action/setForcedUser/:
    parameters:
    - name: contextId
      in: query
      required: true
      description: ''
      schema:
        type: string
    - name: userId
      in: query
      required: true
      description: ''
      schema:
        type: string
    get:
      description: Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)
      operationId: forcedUserActionSetForcedUser
      tags:
      - forcedUser
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/forcedUser/action/setForcedUserModeEnabled/:
    parameters:
    - name: boolean
      in: query
      required: true
      description: ''
      schema:
        type: string
    get:
      description: Sets if 'forced user' mode should be enabled or not
      operationId: forcedUserActionSetForcedUserModeEnabled
      tags:
      - forcedUser
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/forcedUser/view/getForcedUser/:
    parameters:
    - name: contextId
      in: query
      required: true
      description: ''
      schema:
        type: string
    get:
      description: Gets the user (ID) set as 'forced user' for the given context (ID)
      operationId: forcedUserViewGetForcedUser
      tags:
      - forcedUser
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/forcedUser/view/isForcedUserModeEnabled/:
    get:
      description: Returns 'true' if 'forced user' mode is enabled, 'false' otherwise
      operationId: forcedUserViewIsForcedUserModeEnabled
      tags:
      - forcedUser
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
components:
  responses:
    ErrorJson:
      description: Error of JSON endpoints.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorJson'
  schemas:
    ErrorJson:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
        message:
          type: string
        detail:
          type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: X-ZAP-API-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: apikey
      in: query