Available Documentation
API Documentation
System Documentation Admin Panel - management interface
User Access Gateway Portal for end users
API Documentation System integration API
Download PDF API Documentation PDF
Documentation Version
Version 6.2
Version 6.2 Latest version
Version 6.1 Fudo Enterprise 6.1 documentation
Version 6.0 Fudo Enterprise 6.0 documentation
Version 5.6 Fudo Enterprise 5.6 documentation
Archived versions Documentation for older releases
Search in this documentation
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
      • Selected Use Examples
    • 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
      • Data Structures
      • Retrieve Available Attributes of the PrivilegeModel
      • Get List of Available Privileges
    • Roles
      • Data Structures
      • Retrieve Available Attributes of the RoleModel
      • Get Roles List
      • Get Role by ID
      • Create Role
      • Modify Role
      • Grant Privileges to Role
      • Revoke Privileges from Role
      • Delete Role
    • User-Role Assignment
      • Data Structures
      • Retrieve Available Attributes of the UserRoleModel
      • Get User-Role Assignment List
      • Get Role Assigned to a User by Their IDs
      • Create User-Role Assignment
      • Delete User-Role Assignment
    • Groups
      • Data Structures
      • Retrieve Available Attributes of the GroupModel
      • Get Groups List
      • Get Group by ID
      • Create Group
      • Modify Group
      • Delete Group
    • Group-Safe Assignment
      • Data Structures
      • Retrieve Available Attributes of the GroupSafeModel
      • Get Group-Safe Assignment List
      • Get Safe Assigned to a Group by Their IDs
      • Create Group-Safe Assignment
      • Modify Group-Safe Assignment
      • Delete Group-Safe Assignment
    • Group-Safe-TimePolicy Management
      • Data Structures
      • Retrieve Available Attributes of the GroupSafeTimePolicyModel
      • Get Group-Safe-TimePolicy Assignment List
      • Get Group-Safe-TimePolicy Assignment by ID
      • Create Group-Safe-TimePolicy Assignment
      • Modify Group-Safe-TimePolicy Assignment
      • Delete Group-Safe-TimePolicy Assignment
    • Group-User Assignment
      • Data Structures
      • Retrieve Available Attributes of the GroupUser
      • Get Group-User Assignment List
      • Get Group-User Assignment by Their IDs
      • Create Group-User Assignment
      • Delete Group-User Assignment
    • Object Rights
      • Data Structures
      • Retrieve Available Attributes of the ObjectRightsModels
      • Get Available Rights Values for Object Types
    • Access Rights
      • Data Structures
      • Retrieve Available Attributes of the AccessModels
      • Get All Access Rules for Selected Object Type
      • Get Access Rights of a Subject to a Specific Object
      • Examples of Filtered Access Requests
    • Role-Based Capabilities
      • Data Structures
      • Retrieve Available Attributes of the RoleCapabilityModels
      • Get Role-Based Capabilities for Objects
      • Assign Role-Based Capabilities for Objects
      • Get Rights Assigned to a Role (Subject) for an Object by Their IDs
      • Modify Rights Assigned to a Role (Subject) for an Object by Their IDs
      • Grant Specific Rights to a Role (Subject) for an Object by Their IDs
      • Revoke Specific Rights to a Role (Subject) for an Object by Their IDs
      • Delete Role-Based Capability Assigned to a Role (Subject) for an Object by Their IDs
    • User-Based Capabilities
      • Data Structures
      • Retrieve Available Attributes of the UserCapabilityModels
      • Get User-Based Capabilities for Objects
      • Add User-Based Capabilities for Objects
      • Get Rights Assigned to a User (Subject) for an Object by Their IDs
      • Modify Rights Assigned to a User (Subject) for an Object by Their IDs
      • Grant Specific Rights to a User (Subject) for an Object by Their IDs
      • Revoke Specific Rights to a User (Subject) for an Object by Their IDs
      • Delete User-Based Capability Assigned to a ser (Subject) for an Object by Their IDs
  • 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
    • Data Structures
    • Retrieve Available Attributes of the ServerModel
    • Create a Server
    • Get Servers List
    • Get a Server
    • Modify a Server
    • Deleting a Server
  • Pools
    • Data Structures
    • Retrieve Available Attributes of the PoolModel
    • Get Pools List
    • Get a Pool
    • Create a Pool
    • Modify a Pool
    • Deleting a Pool
  • Pool-Server Assignment
    • Data Structures
    • Retrieve Available Attributes of the ServerPoolModel
    • Get Pool-Server Assignment List
    • Get Pool-Server Assignment List by ID’s
    • Adding a Server to the Pool
    • Deleting a Server From a Pool
  • Listeners
    • Data Structures
    • Retrieve Available Attributes of the ListenerModel
    • Get Listeners List
    • Create a Listener
    • Get a Listener
    • Modify a Listener
    • Delete a Listener
  • Safes
    • Data Structures
    • Get Available Attributes of the SafeModel
    • Data Structures: UserSafeAssignmentModel
    • Retrieve Available Attributes of the UserSafeAssignmentModel
    • Data Structures: UserSafeTimePolicyAssignmentModel
    • Retrieve Available Attributes of the UserSafeTimePolicy - AssignmentModel
    • Retrieve Available Attributes of the SafePolicyAssignmentModel
    • Get Safes List
    • Create a Safe
    • Get a Safe
    • Modify a Safe
    • Delete a Safe
    • Get Users’ Time Policy Settings Within Safes
    • Modify a User’s Time Policy Settings Within a Safe
    • Get User’s Settings Within a Safe
    • Modify a User Within a Safe
    • Delete a User From a Safe
    • Get Users Allowed to Manage Selected Safe
    • Get Account-Safe-Listener Assignments List
    • Create an Account-Safe-Listener Assignments
    • Delete an Account-Safe-Listener Assignment
    • Get Safe-Policy Assignments List
    • Checking Safe-Policy Assignment by ID
    • Create an Safe-Policy Assignments
    • Delete a Safe-Policy Assignment
  • Safe Notifications
    • Data Structures
    • Retrieve Available Attributes of the SafeNotificationUsersModel
    • Get Safe Notification Settings for Users
  • User Group Safe
    • Data Structures
    • Retrieve Available Attributes of the UserGroupSafeModel
    • List User Group Safe Assignments
  • Group-Derived Safe Access Policies 🆕
    • Data Structures
    • Retrieve Available Attributes
    • List Overrides
    • Get the Override for a User and Safe
    • Create an Override
    • Modify an Override
    • Delete an Override
    • List Time Policy Entries
    • Get a Time Policy Entry
    • Create a Time Policy Entry
    • Modify a Time Policy Entry
    • Delete a Time Policy Entry
  • Internal Fetch
    • Data Structures
    • Retrieve Available Attributes of the FetchModel
    • Fetch SSH Server Public Key
    • Fetch RDP Server Certificate
  • Fetch and Store Server Keys/Certificates
    • Fetch SSH Key and Update Server
    • Fetch RDP Certificate and Update Server
    • Batch Fetch Multiple Server Keys

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
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the CollectionModel
      • List Collections
      • Get Collection by ID
      • Create Collection
      • Update Collection
      • Delete Collection
      • Import Secrets to Collection
    • Collections Permissions
      • Data Structures
      • Retrieve Available Attributes of the CollectionPermissionModel
      • Get Collection Permissions
    • User Collection Management
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the UserCollectionModel
      • List User Collections
      • Create User Collection Assignment
      • Update User Collection Assignment
      • Remove User Collection Assignment
    • Assigning Collections to Groups
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the GroupCollectionModel
      • List Group Collections
      • Assign Group to Collection
      • Update Group Collection Access
      • Remove Group from Collection
    • Collection Notifications
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the CollectionNotificationUsersModel
      • Get Collection Notification Users
    • Collection Access
      • Data Structures
      • Retrieve Available Attributes of the CollectionAccessModel
      • List Collection Access
      • Get Specific Collection Access
    • Secret Management
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the SecretModel
      • List Secrets
      • Get Secret by ID
      • Create Secret
      • Update Secret
      • Delete Secret
    • Secret Changer Management
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the SecretPasswordChangerModel
      • List Secret Secret Changers
      • Get Secret Changers for Secret
      • Assign Secret Changer to Secret
      • Trigger Password Change
      • Update Secret Secret Changer
      • Remove Secret Changer from Secret
    • Secret Access Management
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the SecretAccessModel
      • List Secret Access Records
      • Get Secret Access for Specific Secret
      • Check In Secret Access
      • Mark Secret as Safe
    • Secret Exposure Monitoring
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the SecretExposureModel
      • Get Secret User Exposure
    • Secret URI Management
      • Overview
      • Data Structures
      • Retrieve Available Attributes of the SecretUriModel
      • List Secret URIs
      • Get Secret URIs for Specific Secret
      • Add URI to Secret
      • Update Secret URI
      • Delete Secret URI
  • 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
      • Data Structures
      • Retrieve Available Attributes of the RegExpModel
      • Get Regular Expressions List
      • Get Regular Expression by ID
      • Defining Regular Expression
      • Modify Regular Expression
      • Deleting Regular Expression
    • Policies
      • Data Structures
      • Get Policies List
      • Get Policy by ID
      • Create Policy
      • Modify Policy
      • Deleting Policy
    • Managing Regular Expressions Assignment
      • Data Structures
      • Retrieve Available Attributes of the RegExpPolicyModel
      • Get the List of Regular Expression Assignments for Policies
      • Assigning Regular Expression to a Policy
      • Checking Regular Expression Assignment With a Policy
      • Deleting Regular Expression Assignment to a Policy
  • 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
      • Data Structures
      • Retrieve Available Attributes of the DiscoveryScannerModel
      • Get Scanners List
      • Get Scanner by ID
      • Create Scanner
      • Modify Scanner
      • Starting Scan
      • Deleting Scanner
    • Discovery Rule
      • Data Structures
    • Retrieve Available Attributes of the DiscoveryRuleModel
    • Get Rules List
    • Get Rule by ID
    • Create Rule
    • Modify Rule
    • Delete Rule
    • Discovery Scanner-Rule Assignment
      • Data Structures
      • Retrieve Available Attributes of the DiscoveryScannerRuleModel
      • Get List of Scanner-Rule Assignment
      • Get Scanner-Rule Assignment by ID
      • Create Scanner-Rule Assignment
      • Modify Scanner–Rule Assignment Attributes
      • Deleting Scanner-Rule Assignment
    • Discovery Rule-Listener Assignment
      • Data Structures
      • Retrieve Available Attributes of the DiscoveryRuleListenerModel
      • Get List of Rule-Listener Assignment
      • Get Rule-Listener Assignment by ID
      • Create Rule-Listener Assignment
      • Deleting Rule-Listener Assignment
    • Discovery Rule-Pool Assignment
      • Data Structures
      • Retrieve Available Attributes of the DiscoveryRulePoolModel
      • Get List of Rule-Pool Assignment
      • Get Rule-Pool Assignment by ID
      • Create Rule-Pool Assignment
      • Deleting Rule-Pool Assignment
    • Discovery Rule-Safe Assignment
      • Data Structures
      • Retrieve Available Attributes of the DiscoveryRuleSafeModel
      • Get List of Rule-Safe Assignment
      • Get Rule-Safe Assignment by ID
      • Create Rule-Safe Assignment
      • Deleting Rule-Safe Assignment
    • Managing Discovery State
      • Changing Multiple Server’s Discovery State
      • Changing Multiple Account’s Discovery State

Sessions & Monitoring

  • Sessions
    • Sessions Management
      • Data Structures
      • Retrieve Available Attributes of the SessionsModel
      • Get Sessions List
      • Get a Session by ID
      • Modify a Session
      • Delete Session
    • Sharing Sessions
      • Data Structures
      • Retrieve Available Attributes of the SessionShareModel
      • Get Session Sharing Information
      • Share Session
    • Session Access History 🆕
      • Data Structures
      • Retrieve Available Attributes of the SessionShareAccessModel
      • Get the Access History of a Session
      • Get the Access History of a Single Share Link
    • Revoking Sharing Sessions
      • Data Structures
      • Retrieve Available Attributes of the SessionShareRevokeModel
      • Revoke Session Sharing URL
    • Terminating Sessions
      • Data Structures
      • Retrieve Available Attributes of the SessionTerminateModel
      • Terminate Live Session
    • Session Text
      • Data Structures
      • Retrieve Available Attributes of the SessionTextModel
      • Get Recorded Text From Session
    • Session OCR
      • Data Structures
      • Retrieve Available Attributes of the SessionOCRModel
      • Check Session OCR Status
      • Process Session for OCR
    • Session Comment
      • Data Structures
      • Retrieve Available Attributes of the SessionCommentModel
      • Get Session Comments
      • Get Session Comment by ID
      • Add Session Comment
      • Modify Session Comment
      • Delete Session Comment
    • Sessions Approval
      • Data Structures
      • Retrieve Available Attributes of the SessionApproveModel
      • Retrieve Available Attributes of the SessionRejectModel
      • Approving Session
      • Rejecting Session
    • Restoring Session
      • Data Structures
      • Retrieve Available Attributes of the SessionRestoreModel
      • Restoring Session
    • Session Last Activity
      • Data Structures
      • Retrieve Available Attributes of the SessionActivityModel
      • Get Get Session Last Activity
    • Session Data Replication
      • Data Structures
      • Retrieve Available Attributes of the SessionReplicaModel
      • Get Session Replication Details
      • Process Session Replication
    • Session Timestamping
      • Data Structures: SessionTimestampModel
      • Retrieve Available Attributes of the SessionTimestampModel
      • Data Structures: TimestampModel
      • Retrieve Available Attributes of the TimestampModel
      • Get Session Timestamping Details
      • Timestamp Session
      • Delete Session Timestamping
    • Session Download
    • Session Backup
      • Data Structures
      • Retrieve Available Attributes of the SessionBackupModel
      • Mark Existing Session for Back Up
    • Session SCP File
      • Data Structures
      • Retrieve Available Attributes of the ScpFileModel
      • Get SCP File Transfer List for a Session
      • Download SCP File Content by Session and File ID
  • 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
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryModel
      • Get Existing User Directory Configurations
      • Get Existing User Directory Configuration by ID
      • Defining User Directory Configuration
      • Modify User Directory Configuration
      • Deleting User Directory Configuration
    • User Directory Controllers
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryServerModel
      • Get Existing User Directory Controllers Configuration
      • Get Controllers Configuration by User Directory ID
      • Get Controller Configuration by User Directory and Controller ID
      • Defining Controller Configuration for Specific User Directory
      • Modify Controller Configuration for Specific User Directory
      • Deleting Controller from User Directory Configuration
    • User Directory - Adding Group Mapping
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryGroupModel
      • Get Existing User Directory Groups Configuration
      • Get Group Configuration by ID
      • Define Group Configuration for Specific User Directory
      • Modify Group Configuration for Specific User Directory
      • Deleting Group from User Directory Configuration
    • User Directory - Group Mapping - Adding to Groups
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryGroupGroupModel
      • Get Groups Assigned via Group Mapping
      • Get Groups Assigned via a Specific Group Mapping
      • Get Assigned Group by Group Mapping ID and Group ID
      • Define Group Assigned via Group Mapping
      • Delete Group Assigned via Group Mapping
    • User Directory - Group Mapping - Adding to Roles
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryGroupRoleModel
      • Get Roles Assigned via Group Mapping
      • Get Roles Assigned via a Specific Group Mapping
      • Get Assigned Role by Group Mapping ID and Role ID
      • Define Role Assigned via Group Mapping
      • Delete Role Assigned via Group Mapping
    • User Directory - Group Mapping - Assigning External Authentication
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryGroupAuthenticationModel
      • Get External Authentication Assigned via Group Mapping
      • Get External Authentication Assigned via a Specific Group Mapping
      • Get Assigned External Authentication by Group Mapping ID and External Authentication ID
      • Define External Authentication Assigned via Group Mapping
      • Edit External Authentication Assigned via Group Mapping
      • Delete External Authentication Assigned via Group Mapping
    • User Directory Synchronization Status
      • Data Structures
      • Retrieve Available Attributes of the UserDirectoryEnableModel
      • Get User Directory Synchronization Status
      • Enable/Disable User Directory Synchronization
      • Force Full Synchronization

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
      • Data Structures
      • Retrieve Available Attributes of the ReverseProxyModel
      • List Reverse Proxies
      • Get Reverse Proxy by ID
      • Create Reverse Proxy
      • Update Reverse Proxy
      • Delete Reverse Proxy
    • Reverse Proxy Listeners
      • Data Structures
      • Retrieve Available Attributes of the ReverseProxyListenerModel
      • List Listeners for Reverse Proxy
      • Add Listener to Reverse Proxy
      • Remove Listener from Reverse Proxy
  • 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
      • Widget Types
    • 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
Fudo Enterprise 6.2 API documentation
  • Start »
  • Search

© Copyright 2026, Fudo Security Inc.