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 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
Adding a Password Changer Policy to Account
API v2: Authentication
How To Authenticate Using an API Key
Access Rights Restrictions
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
Data Structures
Retrieving a Note From Account
Assign Note to an Account
Modifying a Note
Deleting a Note
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
Listing User’s Authentication Methods
Creating User Authentication Method
Modifying User Authentication Method
Deleting User Authentication Method
API v2: External Authentication
Data Structures
Retrieving External Authentication Methods List
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
Retrieving Users Allowed to Manage Servers
Granting Management Privileges
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
Retrieving Users Allowed to Manage Pools
Granting Access for User to 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
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
Data Structures
Changing Server’s Discovery State
Changing 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
Deleting a Remote Application Definition
API v2: Sessions Management
Data Structures
Retrieving Sessions List
Retrieving a Session by ID
Modifying a Session
Mark Existing Session for Back Up
Deleting Session
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
Retrieving Users Allowed to Manage Given Listener
Granting Management Privileges
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
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: Diagnostics
Data Structures
Downloading Service Data
Retrieving Generated Diagnostics List
Deleting Diagnostics Definition
API v2: Healthcheck
Retrieving Healthcheck Status
API v2: Status
Retrieving Status Information
API v2: Logs
Data Structures
Retrieving Log List
Fudo Enterprise Documentation
PDF
Fudo Enterprise 5.5 API documentation
Start
»
Index
Index