• About documentation
  • Introduction
    • System overview
    • User portal
    • Supported protocols
      • Citrix StoreFront (HTTP)
      • HTTP
      • ICA
      • Modbus
      • MS SQL (TDS)
      • MySQL
      • RDP
      • SSH
      • Telnet 3270
      • Telnet 5250
      • Telnet
      • VNC
      • X11
      • TCP
    • Data model
    • Deployment scenarios
    • Connection modes
    • User authentication methods and modes
    • Security measures
      • Data encryption
      • Backups
      • Permissions
      • Sandboxing
      • Reliability
      • Cluster configuration
    • Dashboard
  • System deployment
    • Requirements
    • Hardware overview
    • System initiation
  • Quick start
    • SSH
      • Prerequisites
      • Configuration
      • Establishing connection
      • Viewing user session
    • SSH in bastion mode
      • Prerequisites
      • Configuration
      • Establishing connection
      • Viewing user session
    • RDP
      • Prerequisites
      • Configuration
      • Establishing an RDP connection with a remote host
      • Viewing user session
    • RDP in bastion mode
      • Prerequisites
      • Configuration
      • Establishing an RDP connection with a remote host
      • Viewing user session
    • Telnet
      • Prerequisites
      • Configuration
      • Establishing a telnet connection with the remote host
      • Viewing user’s session
    • Telnet 5250
      • Prerequisites
      • Configuration
      • Establishing a telnet connection with the remote host
      • Viewing user’s session
    • MySQL
      • Prerequisites
      • Configuration
      • Establishing connection with a MySQL database
      • Viewing user session
    • MS SQL
      • Prerequisites
      • Configuration
      • Establishing connection with a MS SQL database
      • Viewing user session
    • HTTP
      • Prerequisites
      • Configuration
      • Connecting to remote resource
      • Viewing user session
    • Citrix
      • ICA
        • Prerequisites
        • Configuration
        • Creating .ica file with connection parameters
        • Connecting to remote resource
        • Viewing user session
      • ICA via Citrix StoreFront
        • Prerequisites
        • Configuration
        • Connecting to remote resource
        • Viewing user session
    • VNC
      • Prerequisites
      • Configuration
      • Establishing connection
      • Viewing user session
    • Oracle over RemoteApp
      • Prerequisites
      • Configuration
      • Changing registry entries on the RDS domain controller
      • Establishing connection
      • Viewing user session
    • User authentication against external LDAP server
      • Prerequisites
      • Configuration
  • Users
    • Creating a user
    • Editing a user
    • Blocking a user
    • Unblocking a user
    • Deleting a user
    • Time access policy
    • Authentication failures counter
    • Roles
    • Users synchronization
    • Adding a mobile device
    • Removing paired mobile device
    • Two-factor OATH authentication with Google Authenticator
  • Servers
    • Creating a server
      • Static server
        • Creating a Citrix server
        • Creating an HTTP server
        • Creating an ICA server
        • Creating a Modbus server
        • Creating a MS SQL server
        • Creating a MySQL server
        • Creating an RDP server
        • Creating an SSH server
        • Creating a Telnet server
        • Creating a Telnet 3270 server
        • Creating a Telnet 5250 server
        • Creating a VNC server
        • Creating a TCP server
      • Dynamic server
        • Creating a dynamic servers group
        • Adding a single host to a servers group
    • Editing a server
    • Blocking a server
    • Unblocking a server
    • Deleting a server
      • Deleting a static server definition
      • Deleting a dynamically added host
  • Accounts
    • Creating an account
      • Creating an anonymous account
      • Creating a forward account
      • Creating a regular account
    • Editing an account
    • Blocking an account
    • Unblocking an account
    • Deleting an account
  • Listeners
    • Creating a listener
      • Creating a Citrix listener
      • Creating a HTTP listener
      • Creating an ICA listener
      • Creating a Modbus listener
      • Creating a MySQL listener
      • Creating an RDP listener
      • Creating an SSH listener
      • Creating a MS SQL listener
      • Creating a Telnet listener
      • Creating a Telnet 3270 listener
      • Creating a Telnet 5250 listener
      • Creating a VNC listener
      • Creating a TCP listener
    • Editing a listener
    • Blocking a listener
    • Unblocking a listener
    • Deleting a listener
  • Safes
    • Creating a safe
    • Editing a safe
    • Blocking a safe
    • Unblocking a safe
    • Deleting a safe
  • Password changers
    • Password changer policy
      • Defining a password changer policy
      • Editing a password changer policy
      • Deleting a password changer policy
    • Custom password changers
      • Defining a custom password changer
      • Editing a custom password changer
      • Deleting a custom password changer
    • Setting up password changing on a Unix system
    • Setting up password changing on Michrosoft Windows system
  • Policies
  • Sessions
    • Filtering sessions
      • Defining filters
      • Full text search
      • Managing user defined filter definitions
    • Viewing sessions
    • Viewing live sessions
    • Pausing connection
    • Terminating connection
    • Joining live session
    • Sharing sessions
    • Commenting sessions
    • Exporting sessions
    • Deleting sessions
    • OCR processing sessions
    • Timestamping selected sessions
    • Cancelling sessions timestamping
    • Approving pending connections
      • Fudo management interface
      • Fudo Mobile
    • Declining pending connections
      • Fudo administration interface
      • Fudo Mobile
    • Sessions’ retention lockdown
  • Reports
  • Efficiency analyzer
    • Overview
    • Sessions analysis
    • Activity comparison
  • Administration
    • System
      • Date and time
      • SSL certificates
      • Deny new connections
      • SSH access
      • Sensitive features
      • System update
        • Updating system
        • Deleting upgrade snapshot
      • License
      • Diagnostics
      • Configuration encryption
      • Default domain
      • Password complexity
      • Single Sign On in User Portal
    • Network settings
      • Network interfaces configuration
        • Managing physical interfaces
        • Defining IP address using system console
        • Setting up a network bridge
        • Setting up virtual networks (VLANs)
        • Setting up LACP link aggregation
      • Labeled IP addresses
      • Bypasses configuration
      • Routing configuration
      • DNS configuration
      • Proxy servers configuration
      • ARP table configuration
    • Notifications
    • Trusted time-stamping
    • External authentication
    • External passwords repositories
      • CyberArk Enterprise Password Vault
      • Hitachi ID Privileged Access Manager
      • Lieberman Enterprise Random Password Manager
      • Thycotic Secret Server
    • Resources
      • RDP/VNC login screen configuration
      • User portal login screen configuration
    • System version restore
    • System restart
    • SNMP
      • Configuring SNMP
      • SNMP MIBs
      • Getting SNMP readings using snmpwalk
      • Fudo PAM specific SNMP extensions
    • Backups and retention
    • External storage
      • Configuring external storage
      • Expanding external storage device
    • Exporting/importing system configuration
      • Exporting system configuration
      • Importing system configuration
    • Cluster configuration
      • Initiating cluster
      • Adding cluster nodes
      • Editing cluster nodes
      • Deleting cluster nodes
      • Redundancy groups
    • Events log
      • External syslog servers
      • Exporting events log
    • Changing encryption passphrase
    • Integration with CERB server
    • System maintenance
      • Backing up encryption keys
      • Monitoring system condition
      • Hard drive replacement
      • Resetting configuration to default settings
  • Reference information
    • RDP connections broker
    • Log messages
    • Fudo 2.2 to Fudo 3.0 parameters mapping
      • Connection
      • Server
    • Data model migration from Fudo PAM version 2.2 to 3.0
      • Server
      • Safe (previously connection)
      • Account (previously login credentials)
      • Listener (previously bastion or part of a server)
      • Sessions
    • ICA configuration file
      • Non-TLS connections ICA file
      • TLS connections ICA file
  • AAPM (Application to Application Password Manager)
    • Compiling fudopv tool
      • Python
      • Virtual environment
      • Fetching dependencies
      • Package creation script
    • Deploying fudopv without compiling source files
    • Using fudopv
    • API interface
    • Authentication methods
      • Static password
      • Token
  • Service Now
    • Configuration
    • Requesting access to safe
    • Granting access
  • Client applications
    • PuTTY
    • Microsoft Remote Desktop
    • VNC Viewer
    • SQL Server Management Studio
  • 4-Eyes authentication proxy service
    • Installing proxy service
    • Initializing configuration using whlproxyinit
    • Managing clusters using whlproxyctl
      • Adding a cluster
      • Deleting a cluster
      • Displaying cluster’s details
      • Listing clusters
    • Managing nodes using whlproxyctl
      • Adding a node to a cluster
      • Deleting a node
      • Displaying node’s details
      • Listing nodes
  • Troubleshooting
    • Booting up
    • Connecting to servers
    • Logging to administration panel
    • Session playback
    • Cluster configuration
    • Trusted timestamping
    • Support mode
  • Frequently asked questions
  • Glossary
API Documentation
User Portal
PDF PL
Fudo PAM 3.11

This is documentation for the Fudo PAM 3.11 version, which is no longer supported. You may want to check documentation for one of the supported Fudo PAM versions: 5.0, 5.1, 5.2, 5.3 or 5.4.

  • Start »
  • AAPM (Application to Application Password Manager) »
  • API interface

API interface¶

AAPM's API interface is described in detail in the Fudo PAM - API documentation manual.

Related topics:

  • Compiling fudopv tool
  • Using fudopv
  • Deploying fudopv without compiling source files
  • Data model
  • System overview
  • Setting up password changing on a Unix system
Next Previous

© Copyright 2020, Fudo Security Inc.