Citrix Users API

openapi: 3.1.0
info:
  title: Citrix ADC (NetScaler) NITRO Access Policies Users API
  description: REST API for configuring and monitoring Citrix ADC (NetScaler) application delivery controllers, including load balancing virtual servers, services, service groups, SSL certificates, content switching, and system statistics.
  version: '14.1'
  contact:
    name: Citrix Support
    url: https://support.citrix.com/
  termsOfService: https://developer.cloud.com/citrix-developer-terms-of-use
servers:
- url: https://{netscaler-ip}/nitro/v1
  description: Citrix ADC NITRO API
  variables:
    netscaler-ip:
      default: 192.168.1.1
      description: NetScaler management IP address
security:
- nitroAuth: []
tags:
- name: Users
  description: User and group management
paths:
  /user/filter:
    post:
      operationId: filterUsers
      summary: Citrix Filter users
      description: Search and filter users and groups.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserFilterRequest'
      responses:
        '200':
          description: Filtered user list
          content:
            application/json:
              schema:
                type: object
                properties:
                  userListData:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          description: User unique identifier
        userName:
          type: string
          description: Username
        displayName:
          type: string
          description: Display name
        email:
          type: string
          description: Email address
        domain:
          type: string
          description: Active Directory domain
    UserFilterRequest:
      type: object
      properties:
        start:
          type: integer
          description: Start index for pagination
        limit:
          type: integer
          description: Maximum number of results
        search:
          type: string
          description: Search text
  securitySchemes:
    nitroAuth:
      type: apiKey
      in: cookie
      name: NITRO_AUTH_TOKEN
      description: Session cookie from NITRO login
externalDocs:
  description: Citrix ADC NITRO API Reference
  url: https://developer-docs.netscaler.com/en-us/adc-nitro-api/current-release.html