Trellix Web Gateway

Trellix Web Gateway Authentication API

Authentication policy settings

Documentation GitHub OpenAPI

Operations 4

GET /authentication/settings Get authentication settings #

PUT /authentication/settings Update authentication settings #

POST /logout End the current session #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/trellix-web-gateway-authentication-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Trellix Web Gateway Authentication API
  version: '1.0'
  contact:
    name: Trellix Support
    url: https://www.trellix.com/support/
    email: support@trellix.com
  termsOfService: https://www.trellix.com/legal/terms-of-use/
  description: 'Operations tagged Authentication across 2 of this provider''s published API definitions: trellix-web-gateway-policy-openapi.yml, trellix-web-gateway-rest-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{mwg-server}:{port}/Konfigurator/REST/policy
  description: Trellix Web Gateway Policy Endpoint
  variables:
    mwg-server:
      default: mwg.example.com
      description: Hostname or IP address of the Web Gateway appliance
    port:
      default: '4712'
      description: Management port for the REST API
- url: https://{mwg-server}:{port}/Konfigurator/REST
  description: Trellix Web Gateway Appliance
  variables:
    mwg-server:
      default: mwg.example.com
      description: Hostname or IP address of the Web Gateway appliance
    port:
      default: '4712'
      description: Management port for the REST API
security:
- cookieAuth: []
tags:
- name: Authentication
  description: Authentication policy settings
paths:
  /authentication/settings:
    get:
      operationId: getAuthenticationSettings
      summary: Get authentication settings
      description: Retrieve the current user authentication configuration including authentication methods, directory services, and bypass rules.
      tags:
      - Authentication
      responses:
        '200':
          description: Authentication settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationSettings'
        '401':
          description: Unauthorized
    put:
      operationId: updateAuthenticationSettings
      summary: Update authentication settings
      description: Update the user authentication configuration. Changes must be committed to take effect.
      tags:
      - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationSettings'
      responses:
        '200':
          description: Settings updated
        '400':
          description: Invalid settings
        '401':
          description: Unauthorized
    servers:
    - url: https://{mwg-server}:{port}/Konfigurator/REST/policy
      description: Trellix Web Gateway Policy Endpoint
      variables:
        mwg-server:
          default: mwg.example.com
          description: Hostname or IP address of the Web Gateway appliance
        port:
          default: '4712'
          description: Management port for the REST API
  /login:
    post:
      operationId: login
      summary: Authenticate and create a session
      description: Authenticate with the Web Gateway appliance using administrator credentials. Returns a session cookie used for subsequent API calls.
      tags:
      - Authentication
      requestBody:
        required: true
        content:
          application/xml:
            schema:
              type: object
              properties:
                userName:
                  type: string
                  description: Administrator username
                password:
                  type: string
                  description: Administrator password
              required:
              - userName
              - password
      responses:
        '200':
          description: Authentication successful
          headers:
            Set-Cookie:
              description: Session cookie for subsequent requests
              schema:
                type: string
        '401':
          description: Authentication failed - invalid credentials
      security: []
    servers:
    - url: https://{mwg-server}:{port}/Konfigurator/REST
      description: Trellix Web Gateway Appliance
      variables:
        mwg-server:
          default: mwg.example.com
          description: Hostname or IP address of the Web Gateway appliance
        port:
          default: '4712'
          description: Management port for the REST API
  /logout:
    post:
      operationId: logout
      summary: End the current session
      description: Terminate the current authenticated session and invalidate the session cookie.
      tags:
      - Authentication
      responses:
        '200':
          description: Session terminated successfully
    servers:
    - url: https://{mwg-server}:{port}/Konfigurator/REST
      description: Trellix Web Gateway Appliance
      variables:
        mwg-server:
          default: mwg.example.com
          description: Hostname or IP address of the Web Gateway appliance
        port:
          default: '4712'
          description: Management port for the REST API
components:
  schemas:
    AuthenticationSettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether user authentication is enabled
        method:
          type: string
          enum:
          - ntlm
          - kerberos
          - ldap
          - radius
          - basic
          - cookie
          description: Primary authentication method
        fallbackMethod:
          type: string
          enum:
          - ntlm
          - kerberos
          - ldap
          - radius
          - basic
          - cookie
          - none
          description: Fallback authentication method
        directoryServer:
          type: string
          description: LDAP/AD directory server address
        directoryBaseDn:
          type: string
          description: Base DN for directory searches
        bypassIps:
          type: array
          items:
            type: string
          description: IP addresses exempt from authentication
        sessionTimeout:
          type: integer
          description: Authentication session timeout in seconds
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: JSESSIONID
      description: Session cookie obtained via the Konfigurator REST /login endpoint.
x-refined-from:
- trellix-web-gateway-policy-openapi.yml
- trellix-web-gateway-rest-openapi.yml