Fudo Enterprise 5.6 - API DocumentationΒΆ
Welcome!
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:
- 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 π
- Discovery:
- Discovery Scanner π
- Discovery Rule π
- Discovery Scanner-Rule Assignment π
- Discovery Rule-Listener Assignment π
- Discovery Rule-Pool Assignment π
- Discovery Rule-Safe Assignment π
- Two new endpoints in Managing Discovery State for changing multiple objectβs Discovery state.
- Sessions:
- 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 SCP File π
- API v2: Managing Password Changers and Remote Apps in Accounts π
- API v2: IPMI π
- API v2: User Devices π
- API v2: User Directory π
- API v2: Upgrade π
- API v2: License π
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.
- 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 π
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/diagnostics
POST /api/v2/diagnostics
DELETE /api/v2/diagnostics
GET /objspec/account_grant
GET /objspec/listener_grant
GET /objspec/pool_grant
GET /objspec/safe_grant
GET /objspec/server_grant
GET /objspec/user_grant
GET /grant/account
GET /grant/listener
GET /grant/pool
GET /grant/safe
GET /grant/server
GET /grant/user
POST /grant/account
POST /grant/listener
POST /grant/pool
POST /grant/safe
POST /grant/server
POST /grant/user
GET /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
- 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
- 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
- API v2: User Devices π
- API v2: External Authentication
- API v2: Servers
- API v2: Pools
- 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 π
- 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
- API v2: Listeners
- API v2: Batch Requests
- API v2: Notification Filter
- API v2: 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
- API v2: Backup
- API v2: Network
- API v2: Upgrade π
- 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 π