Fudo Enterprise 5.5 - 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.5 APIv2, so you can now utilize it to manage:
We have also added numerous new attributes for the Account object and Session object. From now on, the configuration of all base objects, including Users, Servers, Accounts, Safes, and Listeners, is handled using the new API.
Warning
- Fudo Enterprise 5.5 is the last version supporting the APIv1. The support will be removed in the next release. All scripts using APIv1 should be rewritten to use APIv2.
- Fudo Enterprise 5.5 no longer supports the Mobile Token authentication method used to bind the Fudo Officer mobile application to a User. You must unlink all Fudo Officer bindings from Users before the upgrade. For more details, please refer to the ‘Before You Upgrade’ section below.
- All attributes related to the Mobile Token authentication method were removed from the user_authentication_method object specification.
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 v1: Authentication
- API v1: Password Changers
- Data Structures
- Creating a Password Changer
- Retrieving Password Changers List
- Retrieving a Password Changer
- Modifying Password Changers
- Deleting a Password Changer
- Retrieving Account-Password Changers Assignments List
- Adding a Password Changer to Account
- Deleting an Account-Password Changer Assignment
- API v1: Password Changer Policy
- API v2: Authentication
- API v2: Accounts
- Data Structures
- Creating an Account
- Retrieving Accounts List
- Retrieving an Account
- Modifying an Account
- Granting Access for User to 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: Users
- Data Structures
- Creating a User
- Retrieving Users List
- Retrieving a User
- Modifying a User
- Retrieving User’s Management Privileges
- Revoking User’s Management Privileges
- Granting Access for User to Another 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: 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
- Granting Management Privileges
- 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 Management
- 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: Diagnostics
- API v2: Healthcheck
- API v2: Status
- API v2: Logs