Fudo Enterprise 6.2 - API Documentation

Welcome!

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

AI Session Analysis:

• LLM Providers 🆕 - configure the large language model endpoints the analysis runs on

• AI Session Analysis Agents 🆕 - define the agents, attach them to safes and switch live analysis on

• AI Session Analysis Results 🆕 - read the per-agent analyses and their verdicts, and adjudicate a verdict

Access Control:

• Location Policies 🆕 - allow or block connections by country and network, applied to users through groups

• Group-Derived Safe Access Policies 🆕 - narrow a single user’s group-derived access to a safe, with its own time policy

• Access Request Reason Formats 🆕 - require access request reasons to follow a predefined set of fields

System Management:

• Hardware Security Module 🆕 - store the master key in a hardware security module over PKCS#11

• Secret Audit 🆕 - check password vault secrets against a database of compromised passwords

• JWT Provider Management 🆕 - accept JSON Web Tokens issued by an external identity provider

Session Sharing:

• Session Access History 🆕 - access history of a shared session, with identity, source address and view times

• UAG - Session Sharing 🆕 and UAG - Session Share Access 🆕 - users share their own live sessions from the User Access Gateway

• UAG - Live Sessions 🆕 and UAG - Shared Session Details 🆕 - watch a shared session and read its details

• UAG - Session Resolution 🆕 and UAG - Session Comments 🆕 - resolve a share key to a session and comment on it

User Access Gateway Enhancements:

• UAG - Change Password 🆕 - users change their own password from the portal

• UAG - Access Request Reason Formats 🆕 - read the reason formats a request must follow

Updates to Existing Object Specifications:

• Oracle protocol added to the protocol lists of Listeners, Servers, Sessions Management and Push Notifications, and to their TLS conditions

• Session: live analysis results (analysis_status, analysis_severity, analysis_peak_severity, analysis_summary, analysis_verdict_count), listener_hidden, and the new waiting_supervision status

• Safe: jit_mode for time-based Just-in-Time approval, rdp_cliprdr_files and rdp_sndrec, live sharing and supervision (allow_user_sharing, live_supervision_required, min_supervisors), analysis_context

• User: the Fudo ShareAccess attributes moved to the fnet authentication method - see the warning below - plus analysis_context, group_ids, scim_email_type and scim_phone_type

• User Authentication Method: new fnet type carrying the Fudo ShareAccess identity, with its fn_* attributes

• Listener: rdp_legacy selects the previous RDP engine; new listeners use FreeRDP 3

• Server: tls_verify_hostname and analysis_context

• OpenID Connect: scope for custom scopes sent to the identity provider

• Policy: new live_analysis type with live_analysis_min_count and live_analysis_min_severity; session_live_analysis added to the notification and push event names

• Group-Safe Assignment: blocked, valid_since and valid_to, matching the user-safe assignment

Warning

The following endpoints were deprecated and have been removed. Please update your integrations accordingly:

• GET /objspec/discovery

• PATCH /account/<account_id>/discovery

• PATCH /server/<server_id>/discovery

The following changes to existing object specifications are not backwards compatible:

• User: pubkey_ec, pubkey_rsa, pubkey_fingerprint, pubkey_trusted_by, pubkey_trusted_at, invite_code, invite_code_expires_at, invited_by and fudo_network are gone from the UserModel. They are replaced by fudo_network_status, fudo_network_username, fudo_network_method_id and fudo_network_pubkey_fingerprint, and by the fn_* attributes of the fnet authentication method.

• Secret: secret names are no longer required to be unique within a collection. Integrations that identified a secret by name must use its identifier.

• Secret Change Policy: rsa1024 was dropped from the values of ssh_keytype.

• User Access Gateway access request: reason is no longer required - a request may instead carry reason_format_id with reason_fields.

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

• 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
• 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
  • 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
• Group-Derived Safe Access Policies 🆕
• 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
• Access Request Reason Formats 🆕
  • Data Structures
  • Retrieve Available Attributes of the AccessRequestReasonFormatModel
  • List Reason Formats
  • Get a Reason Format
  • Create a Reason Format
  • Modify a Reason Format
  • Delete a Reason Format

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
• Secret Audit 🆕
  • Data Structures
  • Retrieve Available Attributes of the SecretAuditModel
  • Get the Active Hash Database
  • Upload a Hash Database
  • Delete the Hash Database

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
  • 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
• 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 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 🆕
  • Data Structures
  • Retrieve Available Attributes
  • List Per-Agent Analyses
  • List Verdicts
  • Adjudicate a Verdict
  • List Adjudications
  • Modify an Adjudication
  • Retract an Adjudication
• 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
• JWT Provider Management 🆕
  • Data Structures
  • Retrieve Available Attributes of the JWTProviderModel
  • List JWT Providers
  • Get JWT Provider Details
  • Get Cached Signing Keys
  • Create JWT Provider
  • Update JWT Provider
  • Refresh Signing Keys
  • Delete JWT Provider
• 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
• LLM Providers 🆕
  • Data Structures
  • Retrieve Available Attributes of the LlmProviderModel
  • List LLM Providers
  • Get an LLM Provider
  • Create an LLM Provider
  • Modify an LLM Provider
  • Delete an LLM Provider
• 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
• Hardware Security Module 🆕
  • Data Structures
  • Retrieve Available Attributes
  • Get the HSM Configuration
  • Get the HSM Status
  • Test or Commit an HSM Configuration
  • Get the Active Bundle
  • Upload a PKCS#11 Bundle
  • Rotate the Key Encryption Key
  • Disable HSM Master-Key Mode
• 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 - Access Request Reason Formats 🆕
  • Data Structures
  • Get Access Request Reason Formats
• UAG - Session Timeout Check
  • Get Session Timeout

User Access Gateway - Sessions

• UAG - Live Sessions 🆕
  • Data Structures
  • Retrieve Available Attributes of the SessionLiveModel
  • Get Live Sessions
  • Get a Single Live Session
• UAG - Session Resolution 🆕
  • Data Structures
  • Retrieve Available Attributes of the SessionResolveModel
  • Resolve the Session of a One-Time Password
  • Resolve the Session of a Share Link
• UAG - Shared Session Details 🆕
  • Data Structures
  • Get Details of a Shared Session
• UAG - Session Sharing 🆕
  • Data Structures
  • Retrieve Available Attributes of the SessionShareModel
  • Get Session Share Links
  • Share a Session
  • Revoke a Session Share Link
• UAG - Session Share Access 🆕
  • Data Structures
  • Retrieve Available Attributes of the SessionShareAccessModel
  • Get Viewers Connected to a Session
• UAG - Session Comments 🆕
  • Data Structures
  • Retrieve Available Attributes of the SessionCommentModel
  • Get Comments of a Shared Session
  • Add a Comment to a Shared Session

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