...
The UDMG Server REST API is implemented by a customized version of the waarp-gatewayd serverprovided by the udmg-server daemon and provides all the operations that can be performed with the UDMG Client or with the UDMG Client.
Authentication
Only Local User Account authentication is supported for the REST API.
SSO and LDAP authentication is only used for the Graphical User Interface.
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:
Obtain user login and password
Build the user ID by concatenating the login, a colon (“:”) character and the password
Encode the obtained identifier in Base64
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:
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp |
HTTP Method | POST |
Description | Adds a new pgp PGP key |
Example URI | http://localhost:808018080/api/sb_pgp |
Authentication | HTTP Basic |
| Consume Content-Type | application/json |
Response Header | Location – The path to the newly created key |
Example | |
Properties |
Add Key: JSON Example
To create a public pgp PGP key, the syntax is a followas follows:
| Example | JSON | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Example Request |
| ||||||||||
| Example Response |
|
...
Property | UI Field Name | Description |
|---|---|---|
| name | Name | The name of the key, must be unique. |
| pgp-name | PGP Name | The key user name. |
| pgp-email | The associated email. | |
| pgp-algo | PGP Algorithm | The algorithm that was used for creating the key (free text, for reference). |
| valid-from | Start Date | The valid from date |
| valid-to | End Date | The expiration date |
| private-key | Private Key | The private key. It must be in ascii armored format. |
| public-key | Public Key | The public key. It must be in ascii armored format. |
| passphrase | Passphrase | The passphrase of the private key. |
| comment | Comment | An additional comment to describe the pgp PGP key. |
List keys
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp |
HTTP Method | GET |
Description | Displays a list of all keys meeting matching with the criteria below. The private key value is not returned. |
Example URI | http://localhost:808018080/api/sb_pgp |
Authentication | HTTP Basic |
| Produce Content-Type | application/json |
URI Parameters | |
Example |
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp/key_name |
HTTP Method | GET |
Description | Retrieves a PGP key details |
Example URI | http://localhost:808018080/api/sb_pgp/test1.pub |
Authentication | HTTP Basic |
| Produce Content-Type | application/json |
Example |
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp/key_name |
HTTP Method | DELETE |
Description | Deletes the given key. |
Example URI | http://localhost:808018080/api/sb_pgp/test1.pub |
Authentication | HTTP Basic |
Audit Management
...