1 Introduction
2 Authentication
3 Common Operations
4 UDMG Specific Operations
5 PGP Key Management
- 5.1 Add Key
  - 5.1.1 Add Key: JSON Example
  - 5.1.2 Add Key: Properties
- 5.2 List Keys
  - 5.2.1 List Keys: JSON Example
  - 5.2.2 List Keys: URI Parameters
- 5.3 Get a Key
  - 5.3.1 Get a Key: JSON Example
- 5.4 Delete a Key
6 Audit Management
- 6.1 List Audit Records
- 6.2 Get an Audit Record

Introduction

The UDMG Server REST API is provided by the udmg-server daemon and provides all the operations that can be performed with the UDMG Client or with the UDMG Admin UI.

Authentication

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

SSO and LDAP authentication is only used for the Graphical User Interface.

The 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:

Step 1	Obtain user login and password.
Step 2	Build the user ID by concatenating the login, a colon (“:”) character and the password.
Step 3	Encode the obtained identifier in Base64.
Step 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.5 server documentation for the common operations:

Service Status
User Management
Transfer Management
History Management
Local Servers Management
Remote Partners Management
Rules Management
Configuration Override

Note

UDMG Server is customized, and the actual API request and response syntax may differ significantly from the original version. Please consult your Stonebranch contact or the Stonebranch Customer Portal for support.

UDMG Specific Operations

In addition to what is supported by the original version of the waarp-gatewayd server, the following commands have been added for UDMG:

PGP Key Management: sb_pgp
Audit Management: sb_audit
Business Service Management: sb_businessservices
User Group Management: sb_usergroups
High Availability Monitoring

PGP Key Management

PGP key records can be stored in the UDMG database and retrieved with the CLI or the REST API. The PGP key records can be used by scripts or by Universal Controller tasks without having to be stored in a local keyring.

Both private and public PGP keys can be stored in the database with AES encryption.

Add Key

	Description

	Description
URI	http://host_name:port/api/sb_pgp
HTTP Method	POST
Description	Adds a new PGP key
Example URI	http://localhost:18080/api/sb_pgp
Authentication	HTTP Basic
Consume Content-Type	application/json
Response Header	Location – The path to the newly created key
Example	See Add Key: JSON Example.
Properties	See Add Key: JSON Properties.