API v2: Authentication

To access Fudo Enterprise data structures via the API interface, you need a user object defined in the local database with the API Key authentication method specified. To obtain the API Key, please follow below steps in the Fudo Enterprise Admin Panel:

• Create new user or edit existing admin user definition.
• Specify the API Key authentication method for this user.
• Generate the API Key value, copy it, and archive it for future API requests.

Note

The API Key cannot be retrieved after saving this authentication method.

For more detailed information, please refer to the Users section of the Fudo Enterprise Documentation.

How To Authenticate Using an API Key

For successful authentication, include the key Authorization with the generated API Key value in the Headers of your API requests.

Example request

curl -k -X GET -H "Authorization:KEDV0gernOHGpiOmAksvegNDFVWihUy9vknnqCoYDU6X5fiaOmvLU9237LuEjFsc" https://10.0.0.0/api/v2/user

Access Rights Restrictions

The same access rights restrictions apply to the API interface as in case of Administration Panel access. Outlined in the table below are the access rights specified for each of the roles available in Fudo Enterprise.

Role	Access rights
user	Connecting to servers through assigned safes. Loggin to the User Portal (requires adding the user to the portal safe). Fetching servers’ passwords (requires additional access right).
service	Accessing SNMP information.
operator	Logging in to the administration panel. Browsing objects: servers, users, safes, accounts, to which the user has been assigned sufficient access permisions. Blocking/unblocking objects: servers, users, safes, listeners, accounts, to which the user has been assigned sufficient access permisions. Generating reports on demand and subscribing to periodic reports. Managing email notifications. Viewing live and archived sessions involving objects (user, safe, account, server), to which the user has been assigned sufficient access permissions. Converting sessions and downloading converted content involving objects (user, safe, account, server), to which the user has been assigned sufficient access permissions. Available dashboard widgets: concurrent sessions, suspicious sessions, account alerts, active users, cluster status, concurrent sessions chart.
admin	Logging in to the administration panel. Managing objects: servers, users, safes, listeners, accounts, to which the user has been assigned sufficient access permisions. Blocking/unblocking objects: servers, users, safes, listeners, accounts, to which the user has been assigned sufficient access permisions. Generating reports on demand and subscribing to periodic reports. Activating/deactivating email notifications. Viewing live and archived sessions involving objects (user, safe, account, server), to which the user has been assigned management privileges. Converting sessions and downloading converted content involving objects (user, safe, account, server), to which the user has been assigned sufficient access permissions. Managing policies. Available dashboard widgets: concurrent sessions, suspicious sessions, account alerts, active users, cluster status, concurrent sessions chart.
superadmin	Full access rights to objects management. Full access rights to system configuration options. Available dashboard widgets: concurrent sessions, suspicious sessions, account alerts, active users, cluster status, concurrent sessions chart, license, system events log.