Fudo Enterprise 6.1 - API Documentation

Welcome!

The following are the enhancements and modifications introduced in version 6.1 of Fudo Enterprise.

Session Monitoring & Analysis:

• Session Commands 🆕 - track and audit commands executed during monitored sessions

• Machine Learning - Session Scoring 🆕 - machine learning-based anomaly detection and session scoring

• Machine Learning - Model Profiles 🆕 - configure ML behavioral models for different protocols (SSH, RDP)

System Management:

• Syslog Server Management 🆕 - configure external syslog servers for centralized log collection

• Dashboard Storage 🆕 - customize user dashboard layouts and widget configurations

• Disk Probe - manually trigger disk scanning for VM disk size changes

User Access Gateway Enhancements:

• Authentication Confirmation 🆕 - re-authentication endpoints for secure access to user profile sections

• Profile Authentication Methods Management 🆕 - manage user authentication methods (list, create, modify, delete)

Updates to Existing Object Specifications:

• Safe: Added HTTP kiosk mode attributes (http_rendered_kiosk_url, http_rendered_kiosk_max_tabs)

• User: SCIM support (scim_managed, scim_blocked, scim_username), FIDO2 authentication (fido2_user_handle)

• User Authentication Method: Enhanced API key support with apikey_hint and apikey_expires_at, full FIDO2/Passkey support

• Secret Change Policy: SSH key type configuration with ssh_keytype attribute

• Server: New RDP attributes (rdp_nla_enabled, rdp_public_key) and TLS certificate store support

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.

Getting Started

• About Documentation
• API Overview
  • API Purpose
  • API Nomenclature
  • Request Format
  • Methods
  • Possible Responses
  • Endpoints and Objects Specification
  • Parameters
  • Attribute’s Properties
  • API BETA Endpoints
• Authentication
  • How To Authenticate Using an API Key
  • Access Rights Restrictions

Core Resources - Users & Groups

• Role-Based Access Control and User Groups
  • Definitions
  • Privileges
  • Roles
  • User-Role Assignment
  • Groups
  • Group-Safe Assignment
  • Group-Safe-TimePolicy Management
  • Group-User Assignment
  • Object Rights
  • Access Rights
  • Role-Based Capabilities
  • User-Based Capabilities
• 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
• User Devices
  • Data Structures
  • Retrieve Available Attributes of the UserDeviceModel
  • Update Mobile Device for Authentication Method
• User Mobile Access (Fudo Officer)
  • Get the User Mobile Access Status
  • Delete User Mobile Access Binding
• User Organization
  • Data Structures
  • Retrieve Available Attributes of the UserOrganizationModel
  • List User Organizations

Core Resources - Accounts

• Accounts
  • Data Structures: AccountModel
  • Retrieve Available Attributes of the AccountModel
  • Create an Account
  • Get Accounts List
  • Get an Account
  • Modify an Account
  • Adding a Secret Changer Policy to Account
  • Modify Password Change Parameters for Account
  • Delete an Account
  • Managing Security Alerts
• 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
  • 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
  • Data Structures
  • Retrieve Available Attributes of the AccountNoteModel
  • Get a Note From Account
  • Assign Note to an Account
  • Modify a Note
  • Deleting a Note

Core Resources - Connection Assets

• Servers
• Pools
• Pool-Server Assignment
• Listeners
• Safes
• Safe Notifications
• User Group Safe
• Internal Fetch
• Fetch and Store Server Keys/Certificates

Access Requests

• Access Request
  • Data Structures
  • Retrieve Available Attributes of the AccessRequestModel
  • Retrieve Available Attributes of the AccessRequestVoteModel
  • Retrieve Available Attributes of the AccessRequestRevokeModel
  • Get Access Requests List
  • Revoking Access Requests
  • Responding to a Pending Access Request

Password Management

• Password Vault
  • Collection Management
  • Collections Permissions
  • User Collection Management
  • Assigning Collections to Groups
  • Collection Notifications
  • Collection Access
  • Secret Management
  • Secret Changer Management
  • Secret Access Management
  • Secret Exposure Monitoring
  • Secret URI Management
• Secret Changers
  • Data Structures
  • Retrieve Available Attributes of the PasswordChangerModel
  • Get Secret Changers List
  • Get Secret Changer by ID
  • Defining Secret Changer
  • Modify Secret Changer
  • Triggering Password Change for the Account
  • Deleting Secret Changer
• Secret Changer Policy
  • Data Structures
  • Retrieve Available Attributes of the PasswordPolicyModel
  • Get Secret Changer Policies List
  • Get Secret Change Policy by ID
  • Defining Secret Change Policy
  • Modify Secret Change Policy
  • Deleting Secret Change Policy
• Policies and Regular Expressions
  • Regular Expressions
  • Policies
  • Managing Regular Expressions Assignment

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
  • 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
  • Data Structures
  • Retrieve Available Attributes of the SessionSummaryModel
  • List Session Summaries
  • Get Session Summary by Session ID
  • Get Session Transcript for Summary
  • Request Session Summary Generation
• Session Commands 🆕
  • Data Structures
  • Retrieve Available Attributes of the SessionCommandModel
  • List Session Commands
  • Get Specific Session Command
• 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
  • Data Structures
  • Retrieve Available Attributes of the ProductivityModel
  • Get User Productivity Analytics
• Logs
  • Data Structures
  • Retrieve Available Attributes of the LogModel
  • Get Log List
• Syslog Server Management 🆕
  • Data Structures
  • Retrieve Available Attributes of the SyslogServerModel
  • List Syslog Servers
  • Get Syslog Server Details
  • Create Syslog Server
  • Update Syslog Server
  • Delete Syslog Server
  • Configuration Examples
• Notification Filter
  • Data Structures
  • Retrieve Available Attributes of the NotificationFilterModel
  • Get Notifications List
  • Get Notification Filter by ID
  • Create Notification Filter
  • Deleting Notification Filter
• Push Notifications
  • Data Structures
  • Get Push Notification Object Specification
  • List Push Notifications
  • Get Push Notification by ID
• Downloads
  • Data Structures
  • Retrieve available attributes of the SessionFileModel
  • Retrieve Available Attributes of the SessionMovieModel
  • Get Session Files List
  • Get Session Recordings List
  • Downloading Session Files
  • Downloading Session Recordings
  • Deleting Session File
  • Deleting Session Recording
• Machine Learning - Session Scoring 🆕
  • Data Structures
  • Retrieve Available Attributes of the MLSessionScoreModel
  • List ML Session Scores
• Machine Learning Settings
  • Data Structures
  • Get ML Settings
  • Update ML Settings
  • Configuration Examples
  • Related Endpoints
• Machine Learning - Model Profiles 🆕
  • Data Structures
  • Retrieve Available Attributes of the MLModelProfileModel
  • List ML Model Profiles
  • Disable ML Model Profile
  • Enable ML Model Profile

Integrations - Authentication

• External Authentication
  • Data Structures
  • Retrieve Available Attributes of the ExternalAuthentication- Model
  • Get External Authentication Methods List
  • Get External Authentication Method by ID
  • Modify External Authentication Method
  • Create an External Authentication Method
  • Delete an External Authentication Method
• OpenID Connect Configuration
  • Data Structures
  • Retrieve Available Attributes of the OpenIDModel
  • Get Existing OpenID Connect Configurations List
  • Get Existing OpenID Connect Configuration by ID
  • Defining OpenID Connect Configuration
  • Modify OpenID Connect Configuration
  • Deleting 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
• User Directory
  • User Directory Configuration
  • User Directory Controllers
  • User Directory - Adding Group Mapping
  • User Directory - Group Mapping - Adding to Groups
  • User Directory - Group Mapping - Adding to Roles
  • User Directory - Group Mapping - Assigning External Authentication
  • User Directory Synchronization Status

Integrations - External Services

• Remote Applications
  • Data Structures
  • Retrieve Available Attributes of the RemoteApplicationsModel
  • Get Remote Applications Definitions List
  • Get Remote Applications Definitions List by ID
  • Defining Remote Applications Definition
  • Modify Remote Applications Definition
  • Deleting a Remote Application Definition
• Reverse Proxy
  • Reverse Proxy
  • Reverse Proxy Listeners
• External Storage
  • Data Structures
  • Retrieve Available Attributes of the ExternalStorageModel
  • Get External Storage Information
  • Get Specific External Storage Device
  • Configure External Storage
  • Delete External Storage Configuration
• External Password Repository
  • Data Structures
  • Retrieve Available Attributes of the PassvnModel
  • Create External Password Repository
  • Get External Password Repositories List
  • Get Information About External Password Repository by ID
  • Delete an External Password Repository Definition
  • Changing External Password Repository Configuration
• Batch Requests
  • Data Structures
• Create Batch Operation
• Create Batch Operation Using Variable
  • Atomic Functionality

System Administration

• Backup
  • Data Structures
  • Retrieve Available Attributes of the BackupModel
• Create Backup Target
• Get Backup Definitions List
• Get a Backup Definition by ID
• Assign Backup Definition to Session
• Delete Backup Definition
• Upgrade
  • Data Structures
  • Retrieve Available Attributes of the UpgradeModel
  • Upload the Upgrade File
  • Get Uploaded Upgrade Information
  • Run the Upgrade Check
  • Cancel the Upgrade Check
  • Get the Upgrade Check Log
  • Run the Upgrade
  • Delete Upgrade
  • Delete Upgrade Snapshot
• Hotfix
  • Upload the Hotfix File
  • Get Uploaded Hotfix Information
  • Install the Hotfix
  • Delete Uploaded Hotfix File
• License
  • Data Structures
  • Retrieve Available Attributes of the LicenseModel
  • Data Structures
  • Retrieve Available Attributes of the LicenseUploadModel
  • Get License Information
  • Upload the License
  • Delete Uploaded License File
• Exporting/Importing System Configuration
  • Data Structures
  • Retrieve Available Attributes of the ConfigurationModel
  • Exporting the Master Key
  • Exporting System Configuration
  • Importing System Configuration
• Network
  • Data Structures
• Get Network Settings
• Healthcheck
  • Get Healthcheck Status
• Status
  • Get Status Information
• IPMI
  • Data Structures
  • Retrieve Available Attributes of the IPMIModel
  • Get IPMI Configuration Setup
  • Get the Status of IPMI
  • Create IPMI Configuration
• Disk Probe
  • Trigger Disk Scan
• Dashboard Storage 🆕
  • Data Structures
  • Get Dashboard Configuration
  • Get Widget Defaults
  • Update Dashboard Configuration

User Access Gateway - Core

• Authentication Confirmation 🆕
  • Overview
  • Data Structures
  • Retrieve Available Attributes of the ConfirmModel
  • Confirm Authentication Method
  • Invalidate Authentication
• 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
  • Invalidate Reauthentication Token
• UAG - Current User Identity
  • Data Structures
  • Retrieve Available Attributes of the UserIdentityModel
  • Get Current User Identity
• UAG - Accounts List
  • Get Account List
• UAG - Account Safe Listener
  • Data Structures
  • Retrieve Available Attributes of the AccountSafeListenerModel
  • Get User Access Gateway / Safe / Listener Assignment
• UAG - Account Access Request
  • Data Structures
  • Retrieve Available Attributes of the AccessRequestModel
  • Retrieve Available Attributes of the AccessRequestPostModel
  • Retrieve Available Attributes of the AccessRequestRevokeModel
  • Get Access Requests
  • Create Access Request
  • Revoke Access Request
• UAG - Session Timeout Check
  • Get Session Timeout

User Access Gateway - Features

• UAG - Account Remote Applications
  • Data Structures
  • Retrieve Available Attributes of the AccountRemoteAppModel
  • List Remote Applications Assigned to Account
• UAG - Account Notes
  • Data Structures
  • Retrieve Available Attributes of the AccountNoteModel
  • Get Account Notes
  • Update Account Note
• UAG - Account Hotseat Status
  • Data Structures
  • Retrieve Available Attributes of the AccountHotseatModel
  • Request Hotseat Status
• UAG - Secret Checkout and Checkin
  • Data Structures
  • Retrieve Available Attributes of the CheckoutModel
  • Retrieve Available Attributes of the CheckinModel
  • Checkout Secret
  • Repeat Checkout in the Same Session
  • Checkin Secret
• UAG - Account Password History
  • List Password History Entries
  • Get Specific Historical Secret Value

User Access Gateway - Vault

• UAG - Secret Collections
  • Data Structures
  • Retrieve Available Attributes of the CollectionModel
  • List Collections
  • Create Collection
  • Get Collection by ID
  • Update Collection
  • Delete Collection
  • Import Secrets to Collection from CSV
• UAG - Secret Management
  • Data Structures
  • Retrieve Available Attributes of the SecretModel
  • List Secrets
  • Get Secret by ID
  • Create Secret
  • Update Secret
  • Delete Secret
• Secret History
  • Retrieve Available Attributes of the SecretHistoryModel
  • Get Secret History
• Shared Secrets
  • Retrieve Available Attributes of the SecretSharedModel
  • Get Shared Secrets
• Secret URI Management
  • Retrieve Available Attributes of the SecretUriModel
  • List All Secret URIs
  • Get Secret URIs
  • Add URI to Secret
  • Update Secret URI
  • Delete Secret URI
• UAG - Secret Checkout/Checkin
  • Data Structures
  • Retrieve Available Attributes of the SecretCheckoutModel
  • Retrieve Available Attributes of the SecretCheckinModel
  • Checkout Secret
  • Checkin Secret
• UAG - Secret Lookup
  • Data Structures
  • Retrieve Available Attributes of the SecretLookupModel
  • Lookup Secret Value
  • Usage Example with Full Workflow
• UAG - Secret History Reveal
  • Data Structures
  • Retrieve Available Attributes of the SecretHistoryRevealModel
  • Reveal Historical Secret Value
  • Complete Workflow Example
  • Related Endpoints

User Access Gateway - Settings

• UAG - Change Password
  • Data Structures
  • Retrieve Available Attributes of the ChangePasswordModel
  • Change Password
• UAG - Change Language
  • Data Structures
  • Retrieve Available Attributes of the ChangeLanguageModel
  • Change Language
• UAG - OTP Generation
  • Data Structures
  • Retrieve Available Attributes of the OtpModel
  • Generate OTP
• UAG - Generating RDP Configuration
  • Data Structures
  • Retrieve Available Attributes of the RdpConfigModel
  • Generate RDP Configuration