• 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
  • API v2: Authentication
    • How To Authenticate Using an API Key
    • Access Rights Restrictions
  • API v2: Role-Based Access Control and User Groups 🆕
    • API v2: Definitions 🆕
    • API v2: Privileges 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the Privilege- Model
      • Get List of Available Privileges
    • API v2: Roles 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: User-Role Assignment 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: Groups 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the GroupModel
      • Get Groups List
      • Get Group by ID
      • Create Group
      • Modify Group
      • Delete Group
    • API v2: Group-Safe Assignment 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: Group-Safe-TimePolicy Management 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: Group-User Assignment 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: Object Rights 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the Object- RightsModels
      • Get Available Rights Values for Object Types
    • API v2: Access Rights 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: Role-Based Capabilities 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the Role- CapabilityModels
      • 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
    • API v2: User-Based Capabilities 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the User- CapabilityModels
      • 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
  • API v2: Accounts
    • Data Structures
    • Creating an Account
    • Retrieving Accounts List
    • Retrieving an Account
    • Modifying an Account
    • Adding a Password Changer Policy to Account
    • Modifying Password Change Parameters for Account
    • Creating an Account-Safe-Listener Assignments
    • Deleting an Account-Safe-Listener Assignment
    • Deleting an Account
    • Managing Security Alerts
  • API v2: Account Notes
    • Data Structures
    • Retrieving a Note From Account
    • Assign Note to an Account
    • Modifying a Note
    • Deleting a Note
  • API v2: Managing Password Changers and Remote Apps in Accounts 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the AccountScriptModel
    • Get Password Changers and Remote Apps Assigned to Accounts
    • Get Password Changer or Remote App Assigned to an Account by Assignment ID
    • Assign Password Changer or Remote App to an Account
    • Modify Password Changer or Remote App Assignment for an Account
    • Delete Password Changer or Remote App Assignment from an Account
  • API v2: Users
    • Data Structures
    • Creating a User
    • Retrieving Users List
    • Retrieving a User
    • Modifying a User
    • Retrieving User-Safe Assignments List
    • Creating a User-Safe Assignment
    • Retrieving Users’ Time Policy Settings Within Safes
    • Modifying User’s Time Policy Settings Within a Safe
    • Creating User’s Time Policy Settings Within a Safe
    • Deleting a User-Safe Assignment
    • Deleting a User
  • API v2: User Authentication Methods Management
    • Listing User’s Authentication Methods
    • Creating User Authentication Method
    • Modifying User Authentication Method
    • Deleting User Authentication Method
  • API v2: User Devices 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the UserDeviceModel
    • Update Mobile Device for Authentication Method
  • API v2: External Authentication
    • Data Structures
    • Retrieving External Authentication Methods List
    • Retrieving External Authentication Method by ID
    • Modifying External Authentication Method
    • Creating an External Authentication Method
    • Deleting an External Authentication Method
  • API v2: Servers
    • Data Structures
    • Creating a Server
    • Retrieving Servers List
    • Retrieving a Server
    • Modifying a Server
    • Adding a Server to the Pool
    • Deleting a Server From a Pool
    • Deleting a Server
  • API v2: Pools
    • Data Structures
    • Retrieving Pools List
    • Retrieving a Pool
    • Creating a Pool
    • Modifying a Pool
    • Retrieving Server Pools
    • Adding a Server to the Pool
    • Deleting a Server From a Pool
    • Deleting a Pool
  • API v2: Safes
    • Data Structures
    • Retrieving Safes List
    • Creating a Safe
    • Retrieving a Safe
    • Modifying a Safe
    • Deleting a Safe
    • Retrieving Users’ Time Policy Settings Within Safes
    • Modifying a User’s Time Policy Settings Within a Safe
    • Retrieving User’s Settings Within a Safe
    • Modifying a User Within a Safe
    • Deleting a User From a Safe
    • Retrieving Users Allowed to Manage Selected Safe
    • Retrieving Account-Safe-Listener Assignments List
    • Creating an Account-Safe-Listener Assignments
    • Deleting an Account-Safe-Listener Assignment
    • Retrieving Safe-Policy Assignments List
    • Checking Safe-Policy Assignment by ID
    • Creating an Safe-Policy Assignments
    • Deleting a Safe-Policy Assignment
  • API v2: Discovery 🆕
    • Discovery Scanner 🆕
      • Data Structures
      • Retrieving Scanners List
      • Retrieving Scanner by ID
      • Creating Scanner
      • Modifying Scanner
      • Starting Scan
      • Deleting Scanner
    • Discovery Rule 🆕
      • Data Structures
      • Retrieving Rules List
      • Retrieving Rule by ID
      • Creating Rule
      • Modifying Rule
      • Deleting Rule
    • Discovery Scanner-Rule Assignment 🆕
      • Data Structures
      • Retrieving List of Scanner-Rule Assignment
      • Retrieving Scanner-Rule Assignment by ID
      • Creating Scanner-Rule Assignment
      • Modifying Scanner–Rule Assignment Attributes
      • Deleting Scanner-Rule Assignment
    • Discovery Rule-Listener Assignment 🆕
      • Data Structures
      • Retrieving List of Rule-Listener Assignment
      • Retrieving Rule-Listener Assignment by ID
      • Creating Rule-Listener Assignment
      • Deleting Rule-Listener Assignment
    • Discovery Rule-Pool Assignment 🆕
      • Data Structures
      • Retrieving List of Rule-Pool Assignment
      • Retrieving Rule-Pool Assignment by ID
      • Creating Rule-Pool Assignment
      • Deleting Rule-Pool Assignment
    • Discovery Rule-Safe Assignment 🆕
      • Data Structures
      • Retrieving List of Rule-Safe Assignment
      • Retrieving Rule-Safe Assignment by ID
      • Creating Rule-Safe Assignment
      • Deleting Rule-Safe Assignment
    • Managing Discovery State
      • Data Structures
      • Changing Server’s Discovery State
      • Changing Multiple Server’s Discovery State 🆕
      • Changing Account’s Discovery State
      • Changing Multiple Account’s Discovery State 🆕
  • API v2: Password Changer Policy
    • Data Structures
    • Retrieving Password Changer Policies List
    • Retrieving Password Change Policy by ID
    • Defining Password Change Policy
    • Modifying Password Change Policy
    • Deleting Password Change Policy
  • API v2: Password Changers
    • Data Structures
    • Retrieving Password Changers List
    • Retrieving Password Changer by ID
    • Defining Password Changer
    • Modifying Password Changer
    • Triggering Password Change for the Account
    • Deleting Password Changer
  • API v2: Policies and Regular Expressions
    • Regular Expressions
      • Data Structures
      • Retrieving Regular Expressions List
      • Retrieving Regular Expression by ID
      • Defining Regular Expression
      • Modifying Regular Expression
      • Deleting Regular Expression
    • Policies
      • Data Structures
      • Retrieving Policies List
      • Retrieving Policy by ID
      • Defining Policy
      • Modifying Policy
      • Deleting Policy
    • Managing Regular Expressions Assignment
      • Data Structures
      • Retrieving 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
  • API v2: Downloads
    • Data Structures
    • Retrieving Session Files List
    • Retrieving Session Recordings List
    • Downloading Session Files
    • Downloading Session Recordings
    • Deleting Session File
    • Deleting Session Recording
  • API v2: Remote Applications
    • Data Structures
    • Retrieving Remote Applications Definitions List
    • Retrieving Remote Applications Definitions List by ID
    • Defining Remote Applications Definition
    • Modifying Remote Applications Definition
    • Deleting a Remote Application Definition
  • API v2: Sessions 🆕
    • API v2: Sessions Management
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionsModel
      • Get Sessions List
      • Get a Session by ID
      • Modifying a Session
      • Delete Session
    • API v2: Sharing Sessions 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionShareModel
      • Get Session Sharing Information
      • Share Session
    • API v2: Revoking Sharing Sessions 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionShareRevokeModel
      • Revoke Session Sharing URL
    • API v2: Terminating Sessions 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionTerminateModel
      • Terminate Live Session
    • API v2: Session Text 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionTextModel
      • Get Recorded Text From Session
    • API v2: Session OCR 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionOCRModel
      • Check Session OCR Status
      • Process Session for OCR
    • API v2: Session Comment 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionCommentModel
      • Get Session Comments
      • Get Session Comment by ID
      • Add Session Comment
      • Modify Session Comment
      • Delete Session Comment
    • API v2: Sessions Approval 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionApproveModel
      • Request for Retrieving Available Attributes of the SessionRejectModel
      • Approving Session
      • Rejecting Session
    • API v2: Restoring Session 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionRestoreModel
      • Restoring Session
    • API v2: Session Last Activity 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionActivityModel
      • Get Get Session Last Activity
    • API v2: Session Data Replication 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionReplicaModel
      • Get Session Replication Details
      • Process Session Replication
    • API v2: Session Timestamping 🆕
      • Data Structures: SessionTimestampModel
      • Request for Retrieving Available Attributes of the Session- TimestampModel
      • Data Structures: TimestampModel
      • Request for Retrieving Available Attributes of the Timestamp- Model
      • Get Session Timestamping Details
      • Timestamp Session
      • Delete Session Timestamping
    • API v2: Session Download 🆕
    • API v2: Session Backup
      • Data Structures
      • Request for Retrieving Available Attributes of the SessionBackupModel
      • Mark Existing Session for Back Up
    • API v2: Session SCP File 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the ScpFileModel
      • Get SCP File Transfer List for a Session
      • Download SCP File Content by Session and File ID
  • API v2: Access Request
    • Data Structures
    • Retrieving Access Requests List
    • Revoking Access Requests
    • Responding to a Pending Access Request
  • API v2: Reports
    • Data Structures
    • Retrieving Existing Reports List
    • Retrieving Defined Reports List
    • Retrieving Defined Report Subscriptions List
    • Retrieving or Downloading Report File
    • Defining Report Subscription
    • Generating Reports on Demand
    • Deleting Report
    • Deleting Defined Report Subscription
  • API v2: Listeners
    • Data Structures
    • Retrieving Listeners List
    • Creating a Listener
    • Retrieving a Listener
    • Modifying a listener
    • Creating an Account-Safe-Listener Assignments
    • Deleting an Account-Safe-Listener Assignment
    • Deleting a Listener
  • API v2: Batch Requests
    • Data Structures
    • Creating a Batch Operation
    • Creating a Batch Operation Using Variable
    • Atomic Functionality
  • API v2: Notification Filter
    • Data Structures
    • Retrieving Notifications List
    • Retrieving Notification Filter by ID
    • Creating Notification Filter
    • Deleting Notification Filter
  • API v2: OpenID Connect Configuration
    • Data Structures
    • Retrieving Existing OpenID Connect Configurations List
    • Retrieving Existing OpenID Connect Configuration by ID
    • Defining OpenID Connect Configuration
    • Modifying OpenID Connect Configuration
    • Deleting OpenID Connect Configuration
  • API v2: OpenID Connect Users Assignment
    • Data Structures
    • Retrieving the List of Existing OpenID Connect Configuration Assignments to Users
    • Retrieving Existing OpenID Connect Configuration Assigned to User
    • Defining OpenID Connect Configuration Assignment to User
    • Modifying OpenID Connect Configuration Assignment to User
    • Deleting OpenID Connect Configuration Assignment to User
  • API v2: External Password Repository
    • Data Structures
    • Creating External Password Repository
    • Retrieving External Password Repositories List
    • Retrieving Information About External Password Repository by ID
    • Deleting an External Password Repository Definition
    • Changing External Password Repository Configuration
  • API v2: Backup
    • Data Structures
    • Request for Retrieving Available Attributes of the BackupModel
    • Creating a Backup Target
    • Retrieving Backup Definitions List
    • Retrieving a Backup Definition by ID
    • Assigning a Backup Definition to a Session
    • Deleting Backup Definition
  • API v2: Network
    • Data Structures
    • Retrieving Network Settings
  • API v2: Upgrade 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the Upgrade- Model
    • 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
  • API v2: License 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the LicenseModel
    • Data Structures
    • Request for Retrieving Available Attributes of the License- UploadModel
    • Get License Information
    • Upload the License
  • API v2: IPMI 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the IPMIModel
    • Get IPMI Configuration Setup
    • Get the Status of IPMI
    • Create IPMI Configuration
  • API v2: Healthcheck
    • Retrieving Healthcheck Status
  • API v2: Status
    • Retrieving Status Information
  • API v2: Exporting/Importing System Configuration 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the ConfigurationModel
    • Exporting the Master Key
    • Exporting System Configuration
    • Importing System Configuration
  • API v2: User Directory 🆕
    • API v2: User Directory Configuration 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the UserDirectoryModel
      • Retrieving Existing User Directory Configurations
      • Get Existing User Directory Configuration by ID
      • Defining User Directory Configuration
      • Modify User Directory Configuration
      • Deleting User Directory Configuration
    • API v2: User Directory Controllers 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: User Directory - Adding Group Mapping 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: User Directory - Group Mapping - Adding to Groups 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: User Directory - Group Mapping - Adding to Roles 🆕
      • Data Structures
      • Request for Retrieving 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
    • API v2: User Directory - Group Mapping - Assigning External Authentication 🆕
      • Data Structures
      • Request for Retrieving 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
      • Delete External Authentication Assigned via Group Mapping
    • API v2: User Directory Synchronization Status 🆕
      • Data Structures
      • Request for Retrieving Available Attributes of the UserDirectoryEnableModel
      • Get User Directory Synchronization Status
      • Enable/Disable User Directory Synchronization
      • Force Full Synchronization
  • API v2: Logs
    • Data Structures
    • Retrieving Log List
  • API v2: UAG - Current User Identity 🆕
    • Data Structures
    • Get Current User Identity
  • API v2: UAG - Accounts List 🆕
    • Get Account List
  • API v2: UAG - Account Safe Listener 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the UagAccountSafeListenerModel
    • Get User Access Gateway / Safe / Listener Assignment
  • API v2: UAG - Account Access Request 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the AccessRequestModel
    • Get Account Access Requests
    • Create Account Access Request
  • API v2: UAG - Account Remote Applications 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the AccountRemoteAppModel
    • List Remote Applications Assigned to Account
  • API v2: UAG - Account Notes 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the AccountNoteModel
    • Get Account Notes
    • Update Account Note
  • API v2: UAG - Account Hotseat Status 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the AccountHotseatModel
    • Request Hotseat Status
  • API v2: UAG - Secret Checkout and Checkin 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the CheckoutModel
    • Request for Retrieving Available Attributes of the CheckinModel
    • Checkout Secret
    • Repeat Checkout in the Same Session
    • Checkin Secret
  • API v2: UAG - Account Password History 🆕
    • List Password History Entries
    • Get Specific Historical Secret Value
  • API v2: UAG - Change Password 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the ChangePasswordModel
    • Change Password
  • API v2: UAG - Change Language 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the ChangeLanguageModel
    • Change Language
  • API v2: UAG - OTP Generation 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the OtpModel
    • Generate OTP
  • API v2: UAG - Generating RDP Configuration 🆕
    • Data Structures
    • Request for Retrieving Available Attributes of the RdpConfigModel
    • Generate RDP Configuration
  • API v2: UAG - Session Timeout Check 🆕
    • Get Session Timeout
Fudo Enterprise Documentation
PDF
Fudo Enterprise 5.6 API documentation
  • Start »
  • Search

© Copyright 2025, Fudo Security Inc.