Overview
    Alice & Bob
    Sending
    Receiving
    Identity
    Encryption
Technology
    Identity CA
    MTA Identity
    MTA Transport
Changes
Glossary

Identity Management of a Mail Transfer Agent

Identity Management API
Identity Management API
The MTA provides endpoints that support the following use cases:

  1. Fetching the latest identity for a particular address
  2. Fetching an identity for a particular address by serial number
  3. Obtaining a TOTP
  4. Uploading an identity certificate
  5. Obtaining authorisation for issuing an identity certificate
Fetching the latest identity for a particular address

URL: example.com/identity
Protocol: HTTPS
Method: POST
Consumes: application/xml, application/json
Produces: text/plain, application/xml, application/json
Authentication: none
Status Codes: 200, 400, 404, 500

Input: MailAddress object
Output: PEM encoded certificate chain
Error: HttpStatus object
Fetching an identity for a particular address by serial number

URL: example.com/identity/{serialNumber}
Protocol: HTTPS
Method: POST
Consumes: application/xml, application/json
Produces: text/plain, application/xml, application/json
Authentication: none
Status Codes: 200, 400, 500, 502

Input: MailAddress object
Output: PEM encoded certificate chain
Error: HttpStatus object
Obtaining a TOTP

URL: example.com/identity/{totp}
Protocol: HTTPS
Method: GET
Consumes: N/A
Produces: text/plain, application/xml, application/json
Authentication: mutual authentication with client certificate (implementation dependent)
Status Codes: 200, 400, 401, 403, 500

Input: N/A
Output: String
Error: HttpStatus object
Uploading an identity certificate

URL: example.com/identity/mine
Protocol: HTTPS
Method: POST
Consumes: text/plain, application/xml, application/json
Produces: text/plain, application/xml, application/json
Authentication: mutual authentication with client certificate (implementation dependent)
Status Codes: 200, 400, 401, 403, 500

Input: PEM encoded certificate chain
Output: Boolean value (true/false)
Error: HttpStatus object
Obtaining authorisation for issuing an identity certificate

URL: example.com/identity/authorization
Protocol: HTTPS
Method: POST
Consumes: text/plain, application/xml, application/json
Produces: text/plain, application/xml, application/json
Authentication: Mutual Authentication with Client Certificate of Identity CA
Status Codes: 200, 400, 401, 403, 404, 430, 431, 432, 500, 502

Input: AuthorizationRequest object
Output: Boolean value (true/false)
Error: HttpStatus object