Fudo Enterprise 5.6 - API DocumentationΒΆ
Welcome!
The following are the enhancements and modifications introduced in version 5.6 of Fudo Enterprise. Remember to update to the latest available version to benefit from all improvements.
Version 5.6.3 (Latest)
Weβve added two new object specifications and group of endpoints, so you can now utilize APIv2 to manage:
Version 5.6.1
The transition to APIv2 continues, bringing numerous new endpoints designed toΒ enhance functionality and streamline the process ofΒ rewriting tabs toΒ the newΒ API. Consequently, this update aims toΒ significantly improve performance and expand overall capabilities.
Weβve added numerous new object specifications and endpoints to our Fudo Enterprise 5.6 APIv2, soΒ you can now utilize itΒ toΒ manage:
RBAC:
Discovery:
Two new endpoints in Managing Discovery State for changing multiple objectβs Discovery state.
Sessions:
APIv2 for User Access Gateway This release introduces the first set of APIv2 endpoints for User Access Gateway. While the current scope is limited, it marks the beginning of broader API support for managing User Access Gateway programmatically.
Warning
Fudo Enterprise 5.6 no longer supports the APIv1. All scripts using APIv1 should be rewritten to use APIv2.
The following endpoints were deprecated in version 5.5 and have now been removed. Please update your integrations accordingly:
GET /api/v2/diagnosticsPOST /api/v2/diagnosticsDELETE /api/v2/diagnosticsGET /objspec/account_grantGET /objspec/listener_grantGET /objspec/pool_grantGET /objspec/safe_grantGET /objspec/server_grantGET /objspec/user_grantGET /grant/accountGET /grant/listenerGET /grant/poolGET /grant/safeGET /grant/serverGET /grant/userPOST /grant/accountPOST /grant/listenerPOST /grant/poolPOST /grant/safePOST /grant/serverPOST /grant/userGET /grant/<to_user_id>/account/<for_account_id>GET /grant/<to_user_id>/listener/<for_listener_id>GET /grant/<to_user_id>/pool/<for_pool_id>GET /grant/<to_user_id>/safe/<for_safe_id>GET /grant/<to_user_id>/server/<for_server_id>GET /grant/<to_user_id>/user/<for_user_id>DELETE /grant/<to_user_id>/account/<for_account_id>DELETE /grant/<to_user_id>/listener/<for_listener_id>DELETE /grant/<to_user_id>/pool/<for_pool_id>DELETE /grant/<to_user_id>/safe/<for_safe_id>DELETE /grant/<to_user_id>/server/<for_server_id>DELETE /grant/<to_user_id>/user/<for_user_id>
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.
- About Documentation
- API Overview
- API v2: Authentication
- API v2: Role-Based Access Control and User Groups π
- API v2: Definitions π
- API v2: Privileges π
- API v2: Roles π
- API v2: User-Role Assignment π
- API v2: Groups π
- API v2: Group-Safe Assignment π
- API v2: Group-Safe-TimePolicy Management π
- API v2: Group-User Assignment π
- API v2: Object Rights π
- API v2: Access Rights π
- API v2: Role-Based Capabilities π
- API v2: User-Based Capabilities π
- API v2: Accounts
- API v2: 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
- API v2: Account Notes
- 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
- 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
- API v2: 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
- API v2: User Devices π
- API v2: User Mobile Access (Fudo Officer) π
- API v2: External Authentication
- API v2: Servers
- API v2: Pools
- API v2: Pool-Server Assignment
- 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
- 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 π
- 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
- API v2: Password Changer Policy
- API v2: Password Changers
- API v2: Policies and Regular Expressions
- API v2: Downloads
- API v2: Remote Applications
- API v2: Sessions π
- API v2: Sessions Management
- API v2: Sharing Sessions π
- API v2: Revoking Sharing Sessions π
- API v2: Terminating Sessions π
- API v2: Session Text π
- API v2: Session OCR π
- API v2: Session Comment π
- API v2: Sessions Approval π
- API v2: Restoring Session π
- API v2: Session Last Activity π
- API v2: Session Data Replication π
- API v2: Session Timestamping π
- API v2: Session Download π
- API v2: Session Backup
- API v2: Session SCP File π
- API v2: Access Request
- API v2: 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
- API v2: User Productivity Analytics π
- API v2: Listeners
- API v2: Batch Requests
- Create Batch Operation
- Create Batch Operation Using Variable
- API v2: Notification Filter
- API v2: 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
- 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 π
- API v2: Network
- Get Network Settings
- API v2: Upgrade π
- API v2: Hotfix π
- API v2: License π
- API v2: IPMI π
- API v2: Healthcheck
- API v2: Status
- API v2: Exporting/Importing System Configuration π
- API v2: User Directory π
- API v2: User Directory Configuration π
- API v2: User Directory Controllers π
- API v2: User Directory - Adding Group Mapping π
- API v2: User Directory - Group Mapping - Adding to Groups π
- API v2: User Directory - Group Mapping - Adding to Roles π
- API v2: User Directory - Group Mapping - Assigning External Authentication π
- API v2: User Directory Synchronization Status π
- API v2: Logs
- API v2: UAG - Current User Identity π
- API v2: UAG - Accounts List π
- API v2: UAG - Account Safe Listener π
- API v2: UAG - Account Access Request π
- API v2: UAG - Account Remote Applications π
- API v2: UAG - Account Notes π
- API v2: UAG - Account Hotseat Status π
- API v2: UAG - Secret Checkout and Checkin π
- API v2: UAG - Account Password History π
- API v2: UAG - Change Password π
- API v2: UAG - Change Language π
- API v2: UAG - OTP Generation π
- API v2: UAG - Generating RDP Configuration π
- API v2: UAG - Session Timeout Check π