Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Only Local User Account authentication is supported for the REST API.

SSO and LDAP authentication is only used for the Graphical User Interface.See Waarp Gateway REST API Authentication on how to give the credentials


Authentication of REST requests is done using basic HTTP authentication .

This authentication scheme is done using the HTTP Authorization header . To authenticate, the client must:

  1. Obtain user login and password

  2. Build the user ID by concatenating the login, a colon (“:”) character and the password

  3. Encode the obtained identifier in Base64

  4. Prefix the encoded identifier with a declaration of the basic authentication scheme (“Basic”)

For example, if the user enters the name "Aladdin" and the password "open sesame", then the client must send the following header:

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

If the authentication of a request fails, the server will respond with an HTTP code .401 - Unauthorized

By default, the UDMG Server has only one "admin" user (password: "admin_password") with all rights, in order to allow the initial configuration of the gateway to be set up. For security reasons, it is strongly recommended when installing the gateway to create new users with more restricted rights, then to delete this "admin" user.

Common Operations

Refer to the original version of the waarp-gatewayd v0.7.1 server documentation for the common operations:

...