API docs by Redocly

OX Guard API (8.25)

Download OpenAPI specification:Download

Open-Xchange GmbH: info@open-xchange.com URL: https://www.open-xchange.com/

Documentation of the Open-Xchange OX Guard HTTP API

login

The login module is used to obtain a Guard authentication token which can be used to decrypt encrypted data without providing the user's password.

login

Performs a login against the OX Guard Server in order to obtain an authentication token and various user specific settings.

See also auth-token for creating and attaching an authentication token to the user's session.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Request Body schema: application/json
required

The new password which will be set to protect the private key.

encr_password
string

The plain text password of the user's OX Guard key, or null if just fetching user settings.

language
string
Default: "en_EN"

The language code of the client (for example "de_DE"), or null for the default value (en_EN).

Responses

Request samples

Content type
application/json
{
  • "encr_password": "string",
  • "language": "en_EN"
}

Response samples

Content type
application/json
{
  • "server": "string",
  • "cid": 0,
  • "primaryEmail": "string",
  • "pubKey": "string",
  • "auth": "string",
  • "recoveryAvail": true,
  • "lang": {
    },
  • "settings": {
    }
}

logout

Destroys any Guard sessions for the user.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Responses

guest login

Performs a guest login against the OX Guard Server in order to obtain an authentication token and/or various user specific settings.

Request Body schema: application/json
required

Data containing guest credentials.

username
required
string

The guest's username

password
string

The guest password. This parameter can be omitted if the guest logs in the first time AND an initial password is not set/required.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "productName": "string",
  • "auth": "string",
  • "recoveryAvail": true,
  • "settings": {
    }
}

changepass

Changes the password of the user's current key

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Request Body schema: application/json
required

Data containing necessary information in order to change the user's password.

oldpass
required
string

The current password of the key which will be replaced.

newpass
required
string

The new password to set.

Responses

Request samples

Content type
application/json
{
  • "oldpass": "string",
  • "newpass": "string"
}

Response samples

Content type
application/json
{
  • "auth": "string"
}

secondary

Gets the user's secondary email address where password reset information will be sent to.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Responses

changesecondary

Sets the user's secondary email address where password reset information will be sent to.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Request Body schema: application/json
required

Data containing necessary information in order to change the user's password.

password
required
string

The password of the user's current OX Guard key.

email
required
string

The new secondary email address to set.

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "email": "string"
}

reset

Resets the password of the user's current key to a new random password which will be sent to the user's secondary email address, or primary address if no secondary email address is available.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Responses

keys

The keys module provides functionality to create, receive and manage PGP key pairs.

hasKey

Checks if the user has at least one public and/or private PGP key available.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

create

Creates a new PGP key ring for the user and marks the new key ring as "current".

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

The new password which will be set to protect the private key. Can be omitted if e_password is used.

e_password
string

The new, RSA encrypted, password which will be set to protect the private key.

name
required
string

The user's name which will be part of the key identity.

email
string

Optional second email address to be used for password resets

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

delete

Deletes a specific PGP key ring

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyid
required
string

The master key ID of the key ring which should be deleted.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

The password of the private key. Can be omitted if e_password is used or if public key only

e_password
string

The, RSA encrypted, password of the private key.

Responses

getContactKeys

Gets the collection of public PGP key rings associated with a contact.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

contactFolder
required
string

Specifies the Folder of the contact

contactID
required
string

Specifies the ID of the contact

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

getKeys

Gets the user's collection of public PGP key rings.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

getKey

Gets a specific PGP key ring owned by the user containing public and/or private PGP keys. This request fetches detailed information about a specific PGP key ring.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyid
integer <int64>

Specifies the ID of the key to fetch. If this parameter is missing the key marked as "current" is returned instead.

keyType
string
Default: "public_private"
Enum: "public" "private" "public_private"

Specifies if the public and/or the private key of the key ring should be fetched.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

The password of the private key (if keyType is set to 'private' or 'public_private'). Can be omitted if e_password is used.

e_password
string

The, RSA encrypted, password of the private key (if keyType is set to 'private' or 'public_private')

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

downloadKey

Downloads the ASCII armored representation of a specific PGP key ring owned by the user containing public and/or private PGP keys. This request fetches the raw ASCII armored PGP key ring data.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyid
integer <int64>

Specifies the ID of the key to fetch. If this parameter is omitted the key marked as "current" is returned instead.

keyType
string
Default: "public_private"
Enum: "public" "private" "public_private"

Specifies if the public and/or the private key of the key ring should be fetched.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

The password of the private key (if keyType is set to 'private' or 'public_private'). Can be omitted if e_password is used.

e_password
string

The, RSA encrypted, password of the private key (if keyType is set to 'private' or 'public_private')

Responses

setCurrentKey

Marks a Guard PGP key ring as "current".

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyid
required
integer <int64>

The master key ID of the key ring which should be marked as "current".

Responses

upload

Uploads a new ASCII armored key ring to OX Guard. The key ring can contain public and/or private keys.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: multipart/form-data
required
key
required
string <binary>

The ASCII armored data of the key ring.

keyPassword
string

The password of the private key. Can be omitted if the uploaded key ring does only contain public keys.

newPassword
string

The new password to set for the imported private keys. Can be omitted if the uploaded key ring does only contain public keys.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

uploadExternalPublicKey

A user can upload public keys for other external communication partners. This requests uploads an ASCII armored public key of an external recipient for later user.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: multipart/form-data
required
key
required
string <binary>

The ASCII armored data of the key ring.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

getExternalPublicKeys

Gets a list of upload public keys for external recipients. A user can upload public key rings for other external communication partners. This requests gets the uploaded public key rings for externals including useful meta information.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyType
string

Type of key to retrieve. Defaults to uploaded Public Keys. Other example is "autocrypt"

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

shareExternalPublicKey

Marks an uploaded external recipient key as shared or as not shared. An external public key which is marked as shared can be accessed from other OX Guard users in the same context.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyids
required
string

The ids parameter from the ExternalPublicKeyRing object as obtained from the GetExternalPublicKeys request.

share
required
boolean

True, to mark the key ring as "shared", False to mark it as "not shared".

Responses

inlineExternalPublicKey

Marks an uploaded external recipient key as "inline". An external public key which is marked as "inline" produces PGP/INLNE email encryption by default.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyids
required
string

The ids parameter from the ExternalPublicKeyRing object as obtained from the GetExternalPublicKeys request.

inline
required
boolean

True, to mark the key ring as "inline", False to mark it as "not inline".

Responses

deleteExternalPublicKey

Deletes an uploaded external recipient key.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyids
required
string

The ids parameter from the ExternalPublicKeyRing object as obtained from the GetExternalPublicKeys request.

keyType
string

Type of key to retrieve. Defaults to uploaded Public Keys. Other example is "autocrypt"

Responses

addUserId

Adds a new user ID "name " to the given key ring.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: application/x-www-form-urlencoded
required
keyid
required
integer <int64>

The master key ID of the key ring which should be changed.

name
required
string

The name part of "name ".

email
required
string

The email part of "name ".

Responses

revoke

Reovkes a PGP key ring.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyid
required
integer <int64>

Specifies the ID of the master-, or sub-key to revoke.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

The password of the private key. Can be omitted if e_password is used.

e_password
string

The, RSA encrypted, password of the private key.

reason
string
Default: "no_reason"
Enum: "no_reason" "key_superseded" "key_compromised" "key_retired" "user_no_longer_valid"

Specifies the reason why the key is being revoked.

Responses

getRecipKey

Queries the public key of a recipient.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

email
string

The email address of the recipient to search a key for.

keyid
integer <int64>

Instead of using the email parameter it is also possible to perform the search by key ID.

create
boolean

True to create non existing keys for the requested user, False to not create keys with this request (default).

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

getSignatures

Gets the signatures for a user's key.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyid
required
integer <int64>

The ID of the key to get a list of signatures for.

subkeys
boolean
Default: false

True to include signatures for subkeys (only if the given keyid belongs to a master key). False to just return the signatures for the given key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

putautocrypt

Send the autocrpt header to Guard to import or return key details. Client should verify the address in header is part of the mime email

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

add
boolean

If the key should be automatically imported. If false, only key information is returned

confirmed
boolean

True if the user has confirmed this key and wants it added. Marks the key as verified

Request Body schema: application/x-www-form-urlencoded
required
header
required
string

The value of the autoCrypt header from the MIME email

sent_date
required
string

The sent date of the email. Used to establish if the key is new or old relative to any keys already existing

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

Verify autocrypt key

Sets an autocrypt key as verified or not. Only trusted if verified

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

keyids
required
string

The ID of the key to be verified. Should be fingerprint of main public key

verified
required
boolean

True if the user has confirmed this key. Marks the key as verified

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

certificates

The certificates module provides functionality to create, receive and manage S/MIME certificates and keys

hasCertificates

Checks if the user has at least one certificate with a public and/or private S/MIME key available.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

delete

Deletes a specific S/MIME certificate including it's keys

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

serial
required
string

The serial ID of the certificate which should be deleted.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

The password of the private key. Can be omitted if e_password is used

e_password
string

The, RSA encrypted, password of the private key.

Responses

getCertificates

Gets the user's collection of S/MIME certificates.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

getRecipCertificate

Queries the S/MIME certificate of a recipient.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

email
string

The email address of the recipient to search a certificate for.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

upload

Uploads a new S/MIME certificate (in PKCS12 format) to OX Guard.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: multipart/form-data
required
certificate
required
string <binary>

The certificate file

password
string

The password of the certificate's private key.

newPassword
string

The new password to set for the imported certificate.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

upload

Uploads a recipient S/MIME certificate (in PKCS7 format) to OX Guard.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: multipart/form-data
required
certificate
required
string <binary>

The certificate file

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

setCurrentCertificate

Marks a S/MIME certificate as "current".

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

serial
required
integer <int64>

The serial ID of the certificate which should be marked as "current".

Responses

getCertificates

Checks the users ability to create certificates.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

create certificate

Creates a new certificate using configured pki service.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

Request Body schema: multipart/form-data
required
password
required
string

Password to use to protect the key

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

guest

This module provides access to guest functionality.

Assigns Password. DEPRECATED. Deprecated

DEPRECATED, use changepass instead. For new Guest account, assigns new password as well as password reset question/answer.

Request Body schema: application/json
required

Data containing necessary information to assign a new password.

question
required
string

A question to use in the event of a password reset

answer
required
string

The required response to the question to verify a password reset. Can be blank if not supplied

newpass
required
string

The new password for the new account. If no password reset option, can be blank

email
required
string

The email address of the Guest user

itemId
required
string

Item Id of the guest email. Must have a valid email item in order to help verify legit password change

pin
string

If the guest email was sent with optional PIN, must be provided here

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "answer": "string",
  • "newpass": "string",
  • "email": "string",
  • "itemId": "string",
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "auth": "string"
}

Get reset question. DEPRECATED. Deprecated

DEPRECATED. Gets the question to be answered to verify password reset request

query Parameters
email
required
string

The email to be reset

Responses

Reset password. DEPRECATED. Deprecated

DEPRECATED, use reset instead. Performs a password reset for a Guest

query Parameters
email
required
string

The email to be reset

answer
required
string

The answer to the challenge question

language
string

Language for the user

templid
integer

The template id for the custom layout

Responses

Guest account reset, step 1. DEPRECATED. Deprecated

DEPRECATED. First step to reset Guest account. Sends email with temporary token for user

query Parameters
user
required
string

The email address of the user for the reset

templid
integer

Optional templateId for the user for customization

Responses

Perform reset of Guest account. DEPRECATED. Deprecated

DEPRECATED. Performs the reset of the Guest account. Requires secret token sent to them previously

Request Body schema: application/json
required

Data containing necessary information to perform the reset.

resetid
required
string

The reset token string found in the email sent to the user for verification

email
required
string

The email address of the Guest user

password
required
string

The new password for the newly created account

Responses

Request samples

Content type
application/json
{
  • "resetid": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
"string"

Returns the list of email addresses associated with the user from the Middleware

path Parameters
context
required
integer

The context id

userid
required
integer

The id of the user

Responses

Response samples

Content type
application/json
{
  • "primary": "string",
  • "aliases": [
    ]
}

auth

The authentication module to get authentication token for action and saving the token to the session

Check if the session has a valid authentication token

Checks with the middleware if a valid authentication token exists within the session

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

authorize and save to session

Performs a login against the OX Guard Server in order to obtain an authentication token and, optionally, saves the token in the user session for specified period of time

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Request Body schema: application/json
required

The new password to authenticate and duration to remember the password

e_password
string

The RSA encrypted password of the user's OX Guard key. e_password or password must be provided

password
string

Plaintext password of the user's OX Guard Key. Only use if RSA key not available

minutesValid
integer

Minutes to remember the password. "-1" for single use. "0" for indefinite. Omit for not attaching the token to the session at all.

Responses

Request samples

Content type
application/json
{
  • "e_password": "string",
  • "password": "string",
  • "minutesValid": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

Attaches an existing authentication token to the user's session.

Saves an existing authentication token (obtained from a login response) in the user's session for specified period of time.

query Parameters
session
required
string

A session ID previously obtained from the Appsuite HTTP login module.

type
string

Specify the type of cryptography to use. If missing, defaults to PGP. Current types "PGP", "SMIME"

Request Body schema: application/json
required

The new password to authenticate and duration to remember the password

auth
string

The authentication token to attach to the user's session.

minutesValid
integer

Minutes to remember the authentication token. "-1" for single use. "0" for indefinite

type
string

Type of cryptography to use, "PGP" or "SMIME"

Responses

Request samples

Content type
application/json
{
  • "auth": "string",
  • "minutesValid": 0,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

pgpmail

The mail module for performing pgp actions from middleware and sieve

(DEPRECATED) Verify Signature

Verifies signatures in an email

Authorizations:
RestApiAuth
query Parameters
user
required
integer

The ID of the user calling for the verification

context
required
integer

The context of the user calling for the verification

simple
boolean

If true, a simple json with a true/false response returned, otherwise full email returned with header

Request Body schema: application/x-www-form-urlencoded
required
file
required
string

The email

Responses

Response samples

Content type
application/json
{
  • "data": true,
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

(DEPRECATED) Encrypt MIME email

Encrypts an email using the users public key

Authorizations:
RestApiAuth
query Parameters
user
required
integer

The ID of the user calling for the verification

context
required
integer

The context of the user calling for the verification

Request Body schema: application/x-www-form-urlencoded
required
file
required
string

The email to encrypt

Responses

Response samples

Content type
No sample

crypto

The mail module for performing signature verification and email encryption for different types of crypto

Verify Signature

Verifies signatures in an email

Authorizations:
RestApiAuth
query Parameters
user
required
integer

The ID of the user calling for the verification

context
required
integer

The context of the user calling for the verification

simple
boolean

If true, a simple json with a true/false response returned, otherwise full email returned with header

Request Body schema: application/x-www-form-urlencoded
required
file
required
string

The email

Responses

Response samples

Content type
application/json
{
  • "data": true,
  • "error": "string",
  • "error_params": [
    ],
  • "error_id": "string",
  • "error_desc": "string",
  • "error_stack": [
    ],
  • "code": "string",
  • "categories": "string",
  • "category": 0
}

Encrypt MIME email

Encrypts an email using the users public key

Authorizations:
RestApiAuth
query Parameters
user
required
integer

The ID of the user calling for the verification

context
required
integer

The context of the user calling for the verification

fromName
required
string

The name of the sender

email
required
string

Email of the sender

isGuest
required
boolean

If the sender is a guest account

Request Body schema: application/x-www-form-urlencoded
required
file
required
string

The email to encrypt

json
required
string

The email json

guardAuth
string

The Guard authentication token. Required if signing

Responses

Response samples

Content type
No sample

backend

Part of the guard backend plugin

Returns the list of email addresses associated with the user from the Middleware

path Parameters
context
required
integer

The context id

userid
required
integer

The id of the user

Responses

Response samples

Content type
application/json
{
  • "primary": "string",
  • "aliases": [
    ]
}

Support API

The OX Guard Support API enables administrative access to various functions for maintaining OX Guard from a client in a role as a support employee. A client has to do a BASIC AUTH authentication in order to access the API. Username and password can be configured in the guard-core.properties file.

reset_password

Resets the OX Guard password of a user's current key. A new password is sent to the user's secondary email address, or the primary email address as fallback.

query Parameters
email
required
string

Specifies the email of the user whose password should be reset.

Responses

delete_user

Deletes all keys for given user. S/MIME keys are deleted permanently, while PGP keys are backed up, so that they are not usable anymore but are still available as download if marked as "exposed".

Request Body schema: application/x-www-form-urlencoded
user_id
integer

Specifies the user ID of the user whose password should be reset.

cid
integer

Specifies the context ID of the user whose password should be reset.

email
string

If user_id and cid are omitted, the email parameter can be used to specify the user whose keys should be deleted.

Responses

expose_key

Marks a deleted (but backed up) key as "exposed". If a deleted key is marked as "exposed" it is possible to download the key for a configured amount of time by calling the returned URL.

Request Body schema: application/x-www-form-urlencoded
email
string

The email of the user to expose the deleted keys for.

cid
integer

The user's context ID.

Responses

upgrade_guest

Upgrades a guest user to a regular OX Guard user.

Request Body schema: application/x-www-form-urlencoded
required
email
required
string

Specifies the email of the guest user to upgrade

cid
required
integer

The new user's context ID.

user_id
required
integer

The new user's ID.

Responses