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
Retrieve Available Attributes of the
PrivilegeModel
Get List of Available Privileges
API v2: 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
API v2: 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
API v2: Groups 🆕
Data Structures
Retrieve 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
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
API v2: 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
API v2: 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
API v2: Object Rights 🆕
Data Structures
Retrieve Available Attributes of the
ObjectRightsModels
Get Available Rights Values for Object Types
API v2: 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
API v2: 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
API v2: 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
API v2: Accounts
Data Structures:
AccountModel
Retrieve Available Attributes of the
AccountModel
Data Structures:
AccountSafeListenerAssignmentModel
Retrieve Available Attributes of the
AccountSafeListener-
AssignmentModel
Create an Account
Get Accounts List
Get an Account
Modify an Account
Adding a Password Changer Policy to Account
Modify Password Change Parameters for Account
Create an Account-Safe-Listener Assignments
Delete an Account-Safe-Listener Assignment
Delete an Account
Managing Security Alerts
API v2: 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
API v2: Managing Password Changers and Remote Apps in Accounts 🆕
Data Structures
Retrieve 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:
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
Modify User’s Time Policy Settings Within a Safe
Create User’s Time Policy Settings Within a Safe
Delete User-Safe Assignment
Delete User
API v2: User Authentication Methods Management
Retrieve Available Attributes of the
UserAuthentication -
MethodModel
Listing User’s Authentication Methods
Create User Authentication Method
Modify User Authentication Method
Deleting User Authentication Method
API v2: User Devices 🆕
Data Structures
Retrieve Available Attributes of the
UserDeviceModel
Update Mobile Device for Authentication Method
API v2: 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
API v2: Servers
Data Structures
Retrieve Available Attributes of the
ServerModel
Retrieve Available Attributes of the
ServerPoolModel
Create a Server
Get Servers List
Get a Server
Modify a Server
Adding a Server to the Pool
Deleting a Server From a Pool
Deleting a Server
API v2: Pools
Data Structures
Retrieve Available Attributes of the
PoolModel
Retrieve Available Attributes of the
ServerPoolModel
Get Pools List
Get a Pool
Create a Pool
Modify a Pool
Get Server Pools
Adding a Server to the Pool
Deleting a Server From a Pool
Deleting a Pool
API v2: 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
Data Structures:
AccountSafeListenerAssignmentModel
Retrieve Available Attributes of the
AccountSafeListener-
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
API v2: 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
Data Structures
Retrieve Available Attributes of the
DiscoveryModel
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
Retrieve Available Attributes of the
PasswordPolicyModel
Get Password Changer Policies List
Get Password Change Policy by ID
Defining Password Change Policy
Modify Password Change Policy
Deleting Password Change Policy
API v2: Password Changers
Data Structures
Retrieve Available Attributes of the
PasswordChangerModel
Get Password Changers List
Get Password Changer by ID
Defining Password Changer
Modify Password Changer
Triggering Password Change for the Account
Deleting Password Changer
API v2: 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
API v2: 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
API v2: 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
API v2: Sessions 🆕
API v2: Sessions Management
Data Structures
Retrieve Available Attributes of the
SessionsModel
Get Sessions List
Get a Session by ID
Modify a Session
Delete Session
API v2: Sharing Sessions 🆕
Data Structures
Retrieve Available Attributes of the
SessionShareModel
Get Session Sharing Information
Share Session
API v2: Revoking Sharing Sessions 🆕
Data Structures
Retrieve Available Attributes of the
SessionShareRevokeModel
Revoke Session Sharing URL
API v2: Terminating Sessions 🆕
Data Structures
Retrieve Available Attributes of the
SessionTerminateModel
Terminate Live Session
API v2: Session Text 🆕
Data Structures
Retrieve Available Attributes of the
SessionTextModel
Get Recorded Text From Session
API v2: Session OCR 🆕
Data Structures
Retrieve Available Attributes of the
SessionOCRModel
Check Session OCR Status
Process Session for OCR
API v2: 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
API v2: Sessions Approval 🆕
Data Structures
Retrieve Available Attributes of the
SessionApproveModel
Retrieve Available Attributes of the
SessionRejectModel
Approving Session
Rejecting Session
API v2: Restoring Session 🆕
Data Structures
Retrieve Available Attributes of the
SessionRestoreModel
Restoring Session
API v2: Session Last Activity 🆕
Data Structures
Retrieve Available Attributes of the
SessionActivityModel
Get Get Session Last Activity
API v2: Session Data Replication 🆕
Data Structures
Retrieve Available Attributes of the
SessionReplicaModel
Get Session Replication Details
Process Session Replication
API v2: 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
API v2: Session Download 🆕
API v2: Session Backup
Data Structures
Retrieve Available Attributes of the
SessionBackupModel
Mark Existing Session for Back Up
API v2: 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
API v2: 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
API v2: Reports
Data Structures
Retrieve Available Attributes of the
DefinedReportSubscriptionModel
Retrieve Available Attributes of the
ReportModel
Retrieve Available Attributes of the
DefinedReportModel
Get Existing Reports List
Get Defined Reports List
Get Defined Report Subscriptions List
Get or Downloading Report File
Defining Report Subscription
Generating Reports on Demand
Deleting Report
Deleting Defined Report Subscription
API v2: User Productivity Analytics 🆕
Data Structures
Retrieve Available Attributes of the
ProductivityModel
Get User Productivity Analytics
API v2: Listeners
Data Structures
Retrieve Available Attributes of the
ListenerModel
Data Structures:
AccountSafeListenerAssignmentModel
Retrieve Available Attributes of the
AccountSafeListener-
AssignmentModel
Get Listeners List
Create a Listener
Get a Listener
Modify a Listener
Create Account-Safe-Listener Assignments
Delete an Account-Safe-Listener Assignment
Delete a Listener
API v2: Batch Requests
Data Structures
Create Batch Operation
Create Batch Operation Using Variable
Atomic Functionality
API v2: Notification Filter
Data Structures
Retrieve Available Attributes of the
NotificationFilterModel
Get Notifications List
Get Notification Filter by ID
Create Notification Filter
Deleting Notification Filter
API v2: 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
API v2: 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
API v2: 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
API v2: 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
API v2: 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
API v2: Network
Data Structures
Get Network Settings
API v2: 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
API v2: License 🆕
Data Structures
Retrieve Available Attributes of the
LicenseModel
Data Structures
Retrieve Available Attributes of the
LicenseUploadModel
Get License Information
Upload the License
API v2: IPMI 🆕
Data Structures
Retrieve Available Attributes of the
IPMIModel
Get IPMI Configuration Setup
Get the Status of IPMI
Create IPMI Configuration
API v2: Healthcheck
Get Healthcheck Status
API v2: Status
Get Status Information
API v2: Exporting/Importing System Configuration 🆕
Data Structures
Retrieve 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
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
API v2: 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
API v2: 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
API v2: 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
API v2: 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
API v2: 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
Delete External Authentication Assigned via Group Mapping
API v2: 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
API v2: Logs
Data Structures
Retrieve Available Attributes of the
LogModel
Get 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
Retrieve Available Attributes of the
UagAccountSafeListenerModel
Get User Access Gateway / Safe / Listener Assignment
API v2: UAG - Account Access Request 🆕
Data Structures
Retrieve Available Attributes of the
AccessRequestModel
Get Account Access Requests
Create Account Access Request
API v2: UAG - Account Remote Applications 🆕
Data Structures
Retrieve Available Attributes of the
AccountRemoteAppModel
List Remote Applications Assigned to Account
API v2: UAG - Account Notes 🆕
Data Structures
Retrieve Available Attributes of the
AccountNoteModel
Get Account Notes
Update Account Note
API v2: UAG - Account Hotseat Status 🆕
Data Structures
Retrieve Available Attributes of the
AccountHotseatModel
Request Hotseat Status
API v2: 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
API v2: UAG - Account Password History 🆕
List Password History Entries
Get Specific Historical Secret Value
API v2: UAG - Change Password 🆕
Data Structures
Retrieve Available Attributes of the
ChangePasswordModel
Change Password
API v2: UAG - Change Language 🆕
Data Structures
Retrieve Available Attributes of the
ChangeLanguageModel
Change Language
API v2: UAG - OTP Generation 🆕
Data Structures
Retrieve Available Attributes of the
OtpModel
Generate OTP
API v2: UAG - Generating RDP Configuration 🆕
Data Structures
Retrieve 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
»
Index
Index