Authentication
The API supports the following authentication methods that are associated with Privitar API User accounts:
Basic Access authentication: the HTTP (or HTTPs) Basic Authentication header is required, containing the details of an existing Privitar API User.
Mutual TLS authentication: a TLS client Certificate is required. The certificate's Common Name must match the Common Name configured in the details of an existing Privitar API User.
Basic Access authentication should be only used with HTTPS in a production environment, otherwise it's not secure (over plain HTTP)
The API Users calling specific API endpoints must have the corresponding Roles (permissions) assigned per Team.
The available authentication mode is configured per Privitar deployment. Please consult your System Administrator to know which authentication modes are available to you and appropriate for your environment.
For example, it is recommended that Basic Access authentication is only performed using HTTPS in a production environment.
The Privitar on Demand, SecureLink Unveiler and Public Services APIs are based on API Users and always require a TLS certificate and Common Name setup.