API Permission Levels

There are three main permission levels with API functions in ARDI, shown in order of lowest to highest security…

  • Public
  • Guest
  • Admin

Public-Access Functions

Public access functions are available to everyone without any form of authentication.

The main two public functions are Auth and Connect.

Guest Access Functions

Guest indicates that the user is authenticated as a read-access user. If guest mode is active on your server, this can include any client, since all users are read-only users without authentication being required.

If guest mode is not active, all API users will have to authenticate using the Auth endpoint before accessing any non-public functions.

Admin Access Functions

Admin access functions are only available to administrators - users with write permission into the ARDI database.