...
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 Client. – should this be something else or extra "with udmg client?Admin UI.
Authentication
Only Local User Account authentication is supported for the REST API.
...
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:
...
| 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 more comprehensive documentation. — is there other documentation or should this say for "support"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.
...
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 | |
Properties |
| Anchor | ||||
|---|---|---|---|---|
|
Add Key: JSON Example
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp |
HTTP Method | GET |
Description | Displays a list of all keys matching with the criteria below. The private key value is not returned. |
Example URI | http://localhost:18080/api/sb_pgp |
Authentication | HTTP Basic |
| Produce Content-Type | application/json |
Example | |
URI Parameters |
| Anchor | ||||
|---|---|---|---|---|
|
List Keys: JSON Example
...
| URI Parameter | Description | Specifications | RequiredMutually Exclusive With |
|---|---|---|---|
| limit | The maximum number of keys allowed in the response. Set to 20 by default. | String; URI parameter | N**should this column be filled out? |
| offset | Index of the first returned entry. Set to 0 by default. | String; URI parameter | N |
| sort | The setting and order in which keys will be displayed. | String; URI parameter Valid values:
| N |
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp/key_name |
HTTP Method | GET |
Description | Retrieves a PGP key details |
Example URI | http://localhost:18080/api/sb_pgp/test1.pub |
Authentication | HTTP Basic |
| Produce Content-Type | application/json |
Example |
| Anchor | ||||
|---|---|---|---|---|
|
Get a Key: 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:18080/api/sb_pgp/test1.pub |
Authentication | HTTP Basic |
Audit Management
...