Administration API
The Redtrust Administration API is a SOAP/WCF service that provides programmatic access to all operations available in the admin console. It is designed for administrators and integrators who need to automate Redtrust management tasks.
What you can do with the Administration API
The API exposes the same operations as the admin console. For the complete set of available operations, refer to the service WSDL.
This documentation covers the following operations:
- Manage local users: create, edit, activate or deactivate, unblock, and delete.
- Manage certificate users: create and edit.
- Query domain information and list users.
Endpoint
All operations target a single endpoint:
https://YOUR_REDTRUST_IP:8888/RTAdminService.svc/basic
Where:
YOUR_REDTRUST_IPis the IP address or host name of your Redtrust server.8888is the default port. You can change it from the admin console.
The service WSDL is available at https://YOUR_REDTRUST_IP:8888/RTAdminService.svc?wsdl.
Authentication
The /basic endpoint uses WS-Security UsernameToken over HTTPS. You must include the credentials of a Redtrust admin user in every request.
To configure SoapUI, see the SoapUI setup guide.
Request structure
Requests follow the SOAP 1.2 format with the namespace urn:evolium:redtrust:administration:ws.
Response structure
All responses include a Result element with the following fields:
| Field | Type | Description |
|---|---|---|
ResultStatus | string | SUCCESS if the operation completed successfully, ERROR if it failed. |
ErrorCode | string | OK on success. Error code on failure. |
ResultMessage | string | Descriptive message of the result. |
ResultData | variable | Data returned by the operation. The type depends on the method. |
TotalItems | integer | Total number of items affected or returned. |
Next steps
- See the local user management reference.
- See the certificate management reference.
- See the response objects reference for the definition of types returned in
ResultData.