Fudo Enterprise 6.3 - API Documentation¶
Welcome!
The following are the enhancements and modifications introduced in version 6.3 of Fudo Enterprise.
File Transfer Scanning:
Antivirus Engines 🆕 - configure the ICAP antivirus engines that scan files transferred in HTTP sessions, and check their connectivity
File Transfers 🆕 - list the files uploaded and downloaded in sessions, with their size, digests and antivirus verdict
Sessions:
Session HTTP Requests 🆕 - list the HTTP requests recorded in a session, and read their headers and response bodies
System Management:
User Access Gateway Allowed Hosts 🆕 - limit the host names and IP addresses under which the User Access Gateway can be reached
Fudo Officer:
User Mobile Access (Fudo Officer) - administrators initiate Fudo Officer pairing for a user with
POST /user/<user_id>/mobile/access; the newcan_initiateattribute tells whether this is possibleProfile Authentication Methods Management - users complete the pairing in the User Access Gateway by generating the QR code for the mobile application, and unpair it themselves
User Access Gateway Enhancements:
UAG - Change Password - read the password complexity requirements that apply to the user before changing the password
Updates to Existing Object Specifications:
External Authentication: new
tacacstype for TACACS+ servers, withtacacs_method,tacacs_append_domainand client certificate authentication (tls_client_certificate,tls_client_key,tls_client_key_passphrase)Safe:
block_concurrent_sessions,rdp_file_signing_enabled, file transfer in the RDP Web Client (rdp_webclient_file_upload_enabled,rdp_webclient_file_download_enabled,rdp_webclient_file_quota) andfile_transfer_av_scanningSession:
malware_detectedSession Command:
sourcetells shell commands captured in SSH sessions from commands controlled by the Fudo sudo plugin;started_atholds the time the user started typing the commandReverse Proxy:
webclient_rdp,webclient_sshandwebclient_vncallow web client connections without a native listenerReverse Proxy Listener:
external_addressandexternal_portshown to users in the User Access GatewayAnalysis Agent:
provider_idcan be changed on built-in agents; the read-onlyprotocolsattribute lists the session protocols the agent runs on, managed with the new agent protocol endpointsExternal Storage:
is_supportedBackup:
sftp_serverkeyis no longer protectedUser Access Gateway identity:
mobile_supportedin the current user identityUser Access Gateway RDP configuration: .rdp files are signed with the certificate of the RDP listener;
hostandportare optional
Warning
The following changes to existing object specifications are not backwards compatible:
Safe:
http_rendered_file_quotamust be at least1048576(1 MiB). Smaller values are rejected.User Access Gateway RDP configuration:
server_idandlistener_idare deprecated and ignored. The listener and the server are derived from the OTP.
You can search for Fudo Enterprise API features by using the search bar located on your left or refer to the table of contents below.
Table of Contents¶
Getting Started
Core Resources - Users & Groups
- Role-Based Access Control and User Groups
- Users
- Data Structures: UserModel
- Get Available Attributes of the UserModel
- Data Structures: UserSafeAssignmentModel
- Retrieve Available Attributes of the UserSafeAssignmentModel
- Data Structures: UserSafeTimePolicyAssignmentModel
- Retrieve Available Attributes of the UserSafeTimePolicy - AssignmentModel
- Create a User
- Get Users List
- Get a User
- Modify a User
- Get User-Safe Assignments List
- Create a User-Safe Assignment
- Get Users’ Time Policy Settings Within Safes
- Get Users’ Time Policy Settings Within Safes by ID
- Modify User’s Time Policy Settings Within a Safe
- Create User’s Time Policy Settings Within a Safe
- Delete User’s Time Policy Settings Within a Safe
- Delete User-Safe Assignment
- Delete User
- User Authentication Methods Management
- Retrieve Available Attributes of the UserAuthentication - MethodModel
- Listing User Authentication Configurations
- Listing Authentication Configurations for User
- Retrieve User Authentication Configuration by ID
- Create User Authentication Method
- Modify User Authentication Method
- Deleting User Authentication Method
- Location Policies
- Data Structures
- Retrieve Available Attributes
- List Location Policies
- Get a Location Policy
- Create a Location Policy
- Modify a Location Policy
- Delete a Location Policy
- List Location Policy Entries
- Get a Location Policy Entry
- Create a Location Policy Entry
- Modify a Location Policy Entry
- Delete a Location Policy Entry
- List Group Assignments
- Get a Group Assignment
- Assign a Location Policy to a Group
- Remove a Location Policy from a Group
- Get the Policies Effective for a User
- User Devices
- User Mobile Access (Fudo Officer)
- User Organization
Core Resources - Accounts
- Accounts
- Account-Safe-Listener Assignment
- Data Structures: AccountSafeListenerAssignmentModel
- Retrieve Available Attributes of the AccountSafeListener- AssignmentModel
- Get Account-Safe-Listener Assignment List
- Get Account-Safe-Listener Assignment by ID’s
- Create an Account-Safe-Listener Assignments
- Modify an Account-Safe-Listener Assignment
- Delete an Account-Safe-Listener Assignment
- Managing Secret Changers and Remote Apps in Accounts
- Data Structures
- Retrieve Available Attributes of the AccountScriptModel
- Get Secret Changers and Remote Apps Assigned to Accounts
- Get Secret Changer or Remote App Assigned to an Account by Assignment ID
- Encrypted Constant Variables in an Assignment
- Assign Secret Changer or Remote App to an Account
- Modify Secret Changer or Remote App Assignment for an Account
- Delete Secret Changer or Remote App Assignment from an Account
- Account Notes
Core Resources - Connection Assets
Access Requests
Password Management
Automation & Discovery
- Discovery
- Discovery Scanner
- Discovery Rule
- Retrieve Available Attributes of the DiscoveryRuleModel
- Get Rules List
- Get Rule by ID
- Create Rule
- Modify Rule
- Delete Rule
- Discovery Scanner-Rule Assignment
- Discovery Rule-Listener Assignment
- Discovery Rule-Pool Assignment
- Discovery Rule-Safe Assignment
- Managing Discovery State
Sessions & Monitoring
- Sessions
- Sessions Management
- Sharing Sessions
- Session Access History
- Revoking Sharing Sessions
- Terminating Sessions
- Session Text
- Session OCR
- Session Comment
- Sessions Approval
- Restoring Session
- Session Last Activity
- Session Data Replication
- Session Timestamping
- Session Download
- Session Backup
- Session SCP File
- Session Summary
- Session Commands
- File Transfers 🆕
- Session HTTP Requests 🆕
- AI Session Analysis Agents
- Data Structures
- Retrieve Available Attributes
- List Analysis Agents
- Get an Analysis Agent
- Create an Analysis Agent
- Modify an Analysis Agent
- Delete an Analysis Agent
- List Agent Protocols
- Enable a Protocol for an Agent
- Disable a Protocol for an Agent
- List Safe Assignments
- Get a Safe Assignment
- Attach an Agent to a Safe
- Detach an Agent from a Safe
- Get the Live Analysis Switch
- Switch Live Analysis On or Off
- AI Session Analysis Results
- Reports
- Data Structures: ReportModel
- Retrieve Available Attributes of the ReportModel
- Data Structures: DefinedReportSubscriptionModel
- Retrieve Available Attributes of the DefinedReportSubscriptionModel
- Data Structures: DefinedReportModel
- Retrieve Available Attributes of the DefinedReportModel
- Get List of Generated Reports
- Get List of Predefined Report Definitions
- Get List of Subscriptions to Periodic Reports
- Get or Download Report File
- Subscribe to a Periodic Report
- Create New Report Definition (Custom Filter)
- Generate User Report on Demand
- Update Report Definition (Custom Filter)
- Delete Generated User Report
- Delete Report Definition (Custom Filter)
- Unsubscribe from a Recurring Report
- User Productivity Analytics
- Logs
- Syslog Server Management
- Notification Filter
- Push Notifications
- Downloads
- Machine Learning - Session Scoring
- Machine Learning Settings
- Machine Learning - Model Profiles
Integrations - Authentication
- External Authentication
- OpenID Connect Configuration
- OpenID Connect Users Assignment
- Data Structures
- Retrieve Available Attributes of the UserOpenIDModel
- Get the List of Existing OpenID Connect Configuration Assignments to Users
- Get Existing OpenID Connect Configuration Assigned to User
- Defining OpenID Connect Configuration Assignment to User
- Modify OpenID Connect Configuration Assignment to User
- Deleting OpenID Connect Configuration Assignment to User
- JWT Provider Management
- User Directory
Integrations - External Services
System Administration
- Backup
- Create Backup Target
- Get Backup Definitions List
- Get a Backup Definition by ID
- Assign Backup Definition to Session
- Delete Backup Definition
- Upgrade
- Hotfix
- License
- Exporting/Importing System Configuration
- Hardware Security Module
- Network
- Get Network Settings
- User Access Gateway Allowed Hosts 🆕
- Healthcheck
- Status
- IPMI
- Disk Probe
- Dashboard Storage
User Access Gateway - Core
- Authentication Confirmation
- Profile Authentication Methods Management
- Overview
- Authentication Flow
- Data Structures
- Retrieve Available Attributes of the Authentication MethodModel
- Step 1: Obtain Reauthentication Token
- Step 2: List User’s Authentication Methods
- Create Authentication Method
- Get Authentication Method by ID
- Update Authentication Method
- Delete Authentication Method
- Pair Fudo Officer 🆕
- Unpair Fudo Officer 🆕
- Invalidate Reauthentication Token
- UAG - Current User Identity
- UAG - Accounts List
- UAG - Account Safe Listener
- UAG - Account Access Request
- UAG - Access Request Reason Formats
- UAG - Session Timeout Check
User Access Gateway - Sessions
User Access Gateway - Features
User Access Gateway - Vault
User Access Gateway - Settings