Overview
Documentation of the Open-Xchange OX Guard HTTP API
Version information
Version : 2.6.0
Contact information
Contact : Open-Xchange GmbH
Contact Email : info@open-xchange.com
URI scheme
Host : example.com
BasePath : /appsuite/api/oxguard
Schemes : HTTPS
Tags
-
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.
-
keys : The keys module provides functionality to create, receive and manage PGP key pairs.
-
settings : The settings module provides functionality for changing user related PGP options.
-
guest : This module provides access to guest functionality.
Consumes
-
application/x-www-form-urlencoded
Produces
-
application/json
Paths
Change Password
POST /guest?action=changepass
Description
Changes guest password
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
auth |
The authorization code provided from previous login |
string |
|
Query |
session |
A session obtained during the login throug the Guest login |
string |
|
Body |
ChangePassRequestData |
Data containing necessary information to change a password. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
New auth response |
Tags
-
guest
Perform reset of Guest account
POST /guest?action=doresetaccount
Description
Performs the reset of the Guest account. Requires secret token sent to them previously
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Body |
DoResetAccountRequestData |
Data containing necessary information to perform the reset. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
"OK" or an error message in case of an error. |
string |
Tags
-
guest
Assigns Password
POST /guest?action=firstpass
Description
For new Guest account, assigns new password as well as password reset question/answer
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Body |
GuestFirstPasswordRequestData |
Data containing necessary information to assign a new password. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
New auth response |
Tags
-
guest
Gets email attachment
GET /guest?action=getattach
Description
Gets and email attachment
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
attname |
name of the attachment |
string |
|
Query |
auth |
required authorization token |
string |
|
Query |
cid |
The context ID of the user |
integer |
|
Query |
download |
If true, Content-disposition sent so that file is saved |
boolean |
|
Query |
email |
Guard email id |
string |
|
Query |
language |
language of the UI |
string |
|
Query |
session |
A session obtained during the login throug the Guest login |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response will contain decoded attachment stream. If download set, will have Content-Disposition set to "attachment" with the filename. |
No Content |
Produces
-
application/octet-stream -
file-mime-type
Tags
-
guest
Gets email image
GET /guest?action=getattachcid
Description
Gets image contained in the body of an email (cid image)
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
auth |
required authorization token |
string |
|
Query |
cid |
The context ID of the user |
integer |
|
Query |
content_id |
the image cid (image id) |
string |
|
Query |
email |
Guard email id |
string |
|
Query |
session |
A session obtained during the login throug the Guest login |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response will contain decoded attachment stream. |
No Content |
Produces
-
file-mime-type
Tags
-
guest
Get decoded email
POST /guest?action=getmail
Description
Gets decoded email
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
auth |
The authorization code provided from previous login |
string |
|
Query |
session |
A session obtained during the login throug the Guest login |
string |
|
Body |
GetMailRequestData |
Data containing necessary information to change a password. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Email Json |
No Content |
Tags
-
guest
Get reset question
GET /guest?action=getquestion
Description
Gets the question to be answered to verify password reset request
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
email |
The email to be reset |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response will contain the question, error, or "nf" if not found |
No Content |
Produces
-
string
Tags
-
guest
Guest account reset, step 1
GET /guest?action=resetaccount
Description
First step to reset Guest account. Sends email with temporary token for user
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
templid |
Optional templateId for the user for customization |
integer |
|
Query |
user |
The email address of the user for the reset |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
A JSON with data:OK if success, else error message |
No Content |
Tags
-
guest
Reset password
GET /guest?action=resetpassword
Description
Performs a password reset for a Guest
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
answer |
The answer to the challenge question |
string |
|
Query |
email |
The email to be reset |
string |
|
Query |
language |
Language for the user |
string |
|
Query |
templid |
The template id for the custom layout |
integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response will contain 'No Match' or 'OK' |
No Content |
406 |
'Error decoding answer', 'Failed to change', or FailNotify |
No Content |
Produces
-
string
Tags
-
guest
Uploads email to cache
POST /guest?action=upload
Description
Guest emails are only stored for a limited time. After that, they need to be re-uploaded.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
auth |
The authorization code provided from previous login |
string |
|
Query |
itemid |
The itemId for the email |
string |
|
Query |
session |
A session obtained during the login throug the Guest login |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK if success |
No Content |
406 |
'Not decodable' if password wrong for email or key unavailable, or other error message |
No Content |
Consumes
-
multipart/form-data
Produces
-
string
Tags
-
guest
DeleteExternalPublicKey
DELETE /keys?action=DeleteExternalPublicKey
Description
Deletes an uploaded external recipient key.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
ids |
The ids parameter from the ExternalPublicKeyRing object as obtained from the GetExternalPublicKeys request. |
string |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key was deleted. |
No Content |
Tags
-
keys
InlineExternalPublicKey
PUT /keys?action=InlineExternalPublicKey
Description
Marks an uploaded external recipient key as "inline". An external public key which is marked as "inline" produces PGP/INLNE email encryption by default.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
ids |
The ids parameter from the ExternalPublicKeyRing object as obtained from the GetExternalPublicKeys request. |
string |
|
Query |
inline |
True, to mark the key ring as "inline", False to mark it as "not inline". |
boolean |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key was marked as inline. |
No Content |
Tags
-
keys
addUserId
PUT /keys?action=addUserId
Description
Adds a new user ID "name <email>" to the given key ring.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
email |
The email part of "name <email>". |
string |
|
FormData |
keyid |
The master key ID of the key ring which should be changed. |
integer(int64) |
|
FormData |
name |
The name part of "name <email>". |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key was successfully marked as current. |
No Content |
Tags
-
keys
create
POST /keys?action=create
Description
Creates a new PGP key ring for the user and marks the new key ring as "current".
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
name |
The user’s name which will be part of the key identity. |
string |
|
FormData |
password |
The new password which will be set to protect the private key. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
The new created key ring. |
Tags
-
keys
delete
POST /keys?action=delete
Description
Deletes a specific PGP key ring
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
keyid |
The master key ID of the key ring which should be deleted. |
string |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
password |
The password of the private key. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key has been deleted. |
No Content |
Tags
-
keys
downloadKey
POST /keys?action=downloadKey
Description
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.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
keyType |
Specifies if the public and/or the private key of the key ring should be fetched. |
enum (public, private, public_private) |
|
Query |
keyid |
Specifies the ID of the key to fetch. If this parameter is omitted the key marked as "current" is returned instead. |
integer(int64) |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
password |
The password of the private key (if keyType is set to 'private' or 'public_private') |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
The public and/or private part of the specified key ring as raw ASCII armored data. |
string(binary) |
Produces
-
application/pgp-keys
Tags
-
keys
getExternalPublicKeys
GET /keys?action=getExternalPublicKeys
Description
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.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
The collection of uploaded external key rings. |
Tags
-
keys
getKey
POST /keys?action=getKey
Description
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.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
keyType |
Specifies if the public and/or the private key of the key ring should be fetched. |
enum (public, private, public_private) |
|
Query |
keyid |
Specifies the ID of the key to fetch. If this parameter is missing the key marked as "current" is returned instead. |
integer(int64) |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
password |
The password of the private key (if keyType is set to 'private' or 'public_private') |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
The public and/or private part of the specified key ring. |
Tags
-
keys
getKeys
GET /keys?action=getKeys
Description
Gets the the user’s collection of public PGP key rings.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
A collection of the user’s public key rings. |
Tags
-
keys
getRecipKey
GET /keys?action=getRecipKey
Description
Queries the public key of a recipient.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
create |
True to create non existing keys for the requested user, False to not create keys with this request (default). |
boolean |
|
Query |
email |
The email address of the recipient to search a key for. |
string |
|
Query |
keyid |
Instead of using the email parameter it is also possible to perform the search by key ID. |
integer(int64) |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
The public key ring of the recipient and some additional meta data. |
Tags
-
keys
hasKey
GET /keys?action=hasKey
Description
Checks if the user has at least one public and/or private PGP key available.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
A JSON object which contains if the user has a private and/or public key setup. |
Tags
-
keys
revoke
POST /keys?action=revoke
Description
Reovkes a PGP key ring.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
keyid |
Specifies the ID of the master key to revoke. |
integer(int64) |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
password |
The password of the private key. |
string |
|
FormData |
reason |
Specifies the reason why the key is being revoked. |
enum (no_reason, key_superseded, key_compromised, key_retired, user_no_longer_valid) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key was revoked. |
No Content |
Tags
-
keys
setCurrentKey
PUT /keys?action=setCurrentKey
Description
Marks a Guard PGP key ring as "current".
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
keyid |
The master key ID of the key ring which should be marked as "current". |
integer(int64) |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key was successfully marked as current. |
No Content |
Tags
-
keys
shareExternalPublicKey
PUT /keys?action=shareExternalPublicKey
Description
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.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
ids |
The ids parameter from the ExternalPublicKeyRing object as obtained from the GetExternalPublicKeys request. |
string |
|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
Query |
shared |
True, to mark the key ring as "shared", False to mark it as "not shared". |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key was marked as shared. |
No Content |
Tags
-
keys
upload
POST /keys?action=upload
Description
Uploads a new ASCII armored key ring to OX Guard. The key ring can contain public and/or private keys.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
key |
The ASCII armored data of the key ring. |
string |
|
FormData |
keyPassword |
The password of the private key. Can be omitted if the uploaded key ring does only contain public keys. |
string |
|
FormData |
newPassword |
The new password to set for the imported private keys. Can be omitted if the uploaded key ring does only contain public keys. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key rings have been imported. |
No Content |
Tags
-
keys
uploadExternalPublicKey
POST /keys?action=uploadExternalPublicKey
Description
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.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
FormData |
key |
The ASCII armored data of the key ring. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
An empty response in case the key rings have been imported. |
No Content |
Tags
-
keys
changepass
POST /login=action=changepass
Description
Changes the password of the user’s current key
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
Body |
changePasswordData |
Data containing necessary information in order to change the user’s password. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Returns an object containing new authentication information. |
Tags
-
login
changesecondary
POST /login=action=changesecondary
Description
Sets the user’s secondary email address where password reset information will be sent to.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
Body |
changeSecondaryData |
Data containing necessary information in order to change the user’s password. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
"OK" or an error message in case of an error. |
string |
Tags
-
login
login
POST /login=action=login
Description
Performs a login against the OX Guard Server in order to obtain an authentication token and various user specific settings.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
Body |
loginData |
The new password which will be set to protect the private key. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Returns an object containing authentication information and settings. |
Tags
-
login
reset
GET /login=action=reset
Description
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.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
"ok" if the new password was sent to the secondary email address, "primary" if it was sent to the primary email address, or an error message if password reset request failed. |
string |
Tags
-
login
secondary
GET /login=action=secondary
Description
Gets the user’s secondary email address where password reset information will be sent to.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Returns the user’s secondary email address or an empty response if no secondary email address is set for the user. |
string |
Tags
-
login
set
POST /settings=action=set
Description
Sets user specific PGP settings. The current active settings are returned within the login-response.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
session |
A session ID previously obtained from the Appsuite HTTP login module. |
string |
|
Body |
settingsData |
The settings to apply for all keys owned by the user. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
"done" if the settings have been stored, an error message otherwise. |
string |
Tags
-
settings
Definitions
ChangePassRequestData
The data for creating password for a new Guest.
| Name | Description | Schema |
|---|---|---|
answer |
The required response to the question to verify a password reset. Can be blank if not supplied |
string |
newpass |
The new password for the new account. If no password reset option, can be blank |
string |
oldpass |
The old password |
string |
question |
A question to use in the event of a password reset. May be blank if not changing |
string |
ChangePasswordRequestData
The data for performing a password change.
| Name | Description | Schema |
|---|---|---|
newpass |
The new password to set. |
string |
oldpass |
The current password of the key which will be replaced. |
string |
ChangePasswordResponse
| Name | Description | Schema |
|---|---|---|
auth |
A new valid authentication token which can be used for authentication in further requests. |
string |
ChangeSecondaryRequestData
The data for performing the change of the secondary email address.
| Name | Description | Schema |
|---|---|---|
email |
The new secondary email address to set. |
string |
password |
The password of the user’s current OX Guard key. |
string |
CreateResponse
| Name | Description | Schema |
|---|---|---|
categories |
Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
string |
category |
Maintained for legacy reasons: The numeric representation of the first category. |
integer |
code |
Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
string |
data |
||
error |
The translated error message. Present in case of errors. |
string |
error_desc |
The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available. |
string |
error_id |
Unique error identifier to help finding this error instance in the server logs. |
string |
error_params |
As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
< string > array |
error_stack |
If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in "server.properties") this field provides the stack trace of associated Java exception represented as a JSON array. |
< string > array |
DoResetAccountRequestData
The data for performing a rest of a Guest account.
| Name | Description | Schema |
|---|---|---|
email |
The email address of the Guest user |
string |
password |
The new password for the newly created account |
string |
resetid |
The reset token string found in the email sent to the user for verification |
string |
ExternalPublicKeyRing
| Name | Description | Schema |
|---|---|---|
ids |
The Identifier of the external key ring. |
string |
inline |
True, if the key is marked as inline, False otherwise. |
boolean |
publicRing |
||
shareLevel |
The share level. A key is considered to be shared if the share level is greater than 0. |
integer |
shared |
True, if the key ring is shared, False otherwise |
boolean |
ExternalPublicKeyRingCollection
| Name | Description | Schema |
|---|---|---|
externalPublicKeyRings |
An array of PGP key rings belonging to external recipients. |
< ExternalPublicKeyRing > array |
GetExternalPublicKeysResponse
| Name | Description | Schema |
|---|---|---|
categories |
Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
string |
category |
Maintained for legacy reasons: The numeric representation of the first category. |
integer |
code |
Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
string |
data |
||
error |
The translated error message. Present in case of errors. |
string |
error_desc |
The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available. |
string |
error_id |
Unique error identifier to help finding this error instance in the server logs. |
string |
error_params |
As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
< string > array |
error_stack |
If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in "server.properties") this field provides the stack trace of associated Java exception represented as a JSON array. |
< string > array |
GetKeyResponse
| Name | Description | Schema |
|---|---|---|
categories |
Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
string |
category |
Maintained for legacy reasons: The numeric representation of the first category. |
integer |
code |
Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
string |
data |
||
error |
The translated error message. Present in case of errors. |
string |
error_desc |
The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available. |
string |
error_id |
Unique error identifier to help finding this error instance in the server logs. |
string |
error_params |
As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
< string > array |
error_stack |
If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in "server.properties") this field provides the stack trace of associated Java exception represented as a JSON array. |
< string > array |
GetKeysResponse
| Name | Description | Schema |
|---|---|---|
categories |
Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
string |
category |
Maintained for legacy reasons: The numeric representation of the first category. |
integer |
code |
Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
string |
data |
||
error |
The translated error message. Present in case of errors. |
string |
error_desc |
The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available. |
string |
error_id |
Unique error identifier to help finding this error instance in the server logs. |
string |
error_params |
As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
< string > array |
error_stack |
If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in "server.properties") this field provides the stack trace of associated Java exception represented as a JSON array. |
< string > array |
GetMailRequestData
The data for creating password for a new Guest.
| Name | Description | Schema |
|---|---|---|
item |
The itemId of the Guest email |
string |
GetRecipKeyResponse
| Name | Description | Schema |
|---|---|---|
categories |
Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
string |
category |
Maintained for legacy reasons: The numeric representation of the first category. |
integer |
code |
Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
string |
data |
||
error |
The translated error message. Present in case of errors. |
string |
error_desc |
The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available. |
string |
error_id |
Unique error identifier to help finding this error instance in the server logs. |
string |
error_params |
As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
< string > array |
error_stack |
If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in "server.properties") this field provides the stack trace of associated Java exception represented as a JSON array. |
< string > array |
GuestFirstPasswordRequestData
The data for creating password for a new Guest.
| Name | Description | Schema |
|---|---|---|
answer |
The required response to the question to verify a password reset. Can be blank if not supplied |
string |
email |
The email address of the Guest user |
string |
itemId |
Item Id of the guest email. Must have a valid email item in order to help verify legit password change |
string |
newpass |
The new password for the new account. If no password reset option, can be blank |
string |
pin |
If the guest email was sent with optional PIN, must be provided here |
string |
question |
A question to use in the event of a password reset |
string |
HasKeyResponse
| Name | Description | Schema |
|---|---|---|
categories |
Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
string |
category |
Maintained for legacy reasons: The numeric representation of the first category. |
integer |
code |
Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
string |
data |
||
error |
The translated error message. Present in case of errors. |
string |
error_desc |
The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available. |
string |
error_id |
Unique error identifier to help finding this error instance in the server logs. |
string |
error_params |
As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
< string > array |
error_stack |
If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in "server.properties") this field provides the stack trace of associated Java exception represented as a JSON array. |
< string > array |
HasKeyResult
An result object which describes if the user has a key pair available or not.
| Name | Description | Schema |
|---|---|---|
hasPrivateKey |
True, if the user has at least one private PGP key, False otherwise |
boolean |
hasPublicKey |
True, if the user has at least one public PGP key, False otherwise |
boolean |
KeyRing
The key ring of the response.
| Name | Description | Schema |
|---|---|---|
contextId |
The context ID of the user |
integer |
current |
Whether the key ring is marked as "current" or not |
boolean |
privateRing |
||
publicRing |
||
userId |
The user ID |
integer |
KeyRingCollection
| Name | Description | Schema |
|---|---|---|
keyRings |
An array of PGP key rings containing public and/or private PGP keys. |
< KeyRing > array |
KeySource
The original source of a key ring
| Name | Description | Schema |
|---|---|---|
name |
The name of the source |
string |
trustLevel |
The source’s level of trust. A higher value means a higher trusted source. |
integer |
trusted |
True if the Guard server thinks the source is trusful, False otherwise. |
boolean |
LoginRequestData
The data for performing a LoginRequest
| Name | Description | Schema |
|---|---|---|
language |
The language code of the client (for example "de_DE"), or null for the default value (en_EN). |
string |
ox_password |
The plain text password of the user’s OX Guard key, or null if just fetching user settings. |
string |
LoginResponse
| Name | Description | Schema |
|---|---|---|
auth |
The authentication token which can be used in further OX Guard requests. |
string |
cid |
The ID of the context the user belongs to. |
integer |
lang |
A set of availble languages translated for the user’s locale. |
< string, string > map |
primaryEmail |
The user’s primary email address. |
string |
pubKey |
The OX Guard server’s own public key. |
string |
recoveryAvail |
Describes if OX Guard password recovery is available for the user’s keys. |
boolean |
server |
The version of the OX Guard backend. |
string |
settings |
A settings object containing various OX Guard settings for the user. |
settings
| Name | Description | Schema |
|---|---|---|
inline |
True to use PGP inline by default when sending encrypted or signed emails, False to use PGP/MIME by default. |
boolean |
min_password_length |
The minimum length of an OX Guard key password. |
integer |
noDeletePrivate |
True if the user is prohibited to remove the private key, False if he is allowed to delete it. |
boolean |
noDeleteRecovery |
False if password recovery is available and the user is allowed to turn it off. True if the user is not allowed to remove the password recovery. |
boolean |
noRecovery |
True if the password recovery for keys is not available, False if the password recovery is available. |
boolean |
password_length |
The maximum length of an OX Guard key password. |
integer |
pgpdefault |
True to encrypt emails by default when composing, False to not encrypt emails by default. |
boolean |
pgpsign |
True to sign emails by default when composing, False to not sign emails by default. |
boolean |
PGPSettingsData
The user’s PGP settings.
| Name | Description | Schema |
|---|---|---|
inline |
True to use PGP inline by default when sending encrypted or signed emails, False to use PGP/MIME by default. |
boolean |
pgpdefault |
True to encrypt emails by default when composing, False to not encrypt emails by default. |
boolean |
pgpsign |
True to sign emails by default when composing, False to not sign emails by default. |
boolean |
PrivateKey
Private key meta data
| Name | Description | Schema |
|---|---|---|
expired |
True, if the key is marked as expired, False otherwise. |
boolean |
id |
The PGP key ID. |
integer(int64) |
masterKey |
True, if the key is the "master" key, false otherwise. |
boolean |
userIds |
An array containing all user identifiers. |
< string > array |
PrivateKeyRing
| Name | Description | Schema |
|---|---|---|
keys |
An array of private keys |
< PrivateKey > array |
ring |
The ASCII armored key material of the private key ring. |
string |
PublicKey
Public key meta data
| Name | Description | Schema |
|---|---|---|
creationTime |
The time stamp of creation (milliseconds since January 1, 1970, 00:00:00 GMT). |
integer(int64) |
encryptionKey |
True, if the key can be used for encryption, false otherwise. |
boolean |
expired |
True, if the key is marked as expired, False otherwise. |
boolean |
fingerPrint |
The hexadecimal representation of the key ID. |
string |
hasPrivateKey |
True, if the public key has a known corresponding private key. |
boolean |
id |
The PGP key ID. |
integer(int64) |
masterKey |
True, if the key is the "master" key, false otherwise. |
boolean |
revoked |
True, if the key has been revoked, false otherwise. |
boolean |
userIds |
An array containing all user identifiers. |
< string > array |
validSeconds |
The amount of seconds that the key is valid. |
integer(int64) |
PublicKeyRing
| Name | Description | Schema |
|---|---|---|
keys |
An array of public keys |
< PublicKey > array |
ring |
The ASCII armored key material of the public key ring. |
string |
RecipKey
The recipient’s key data
| Name | Description | Schema |
|---|---|---|
guest |
True, if the recipient is treated as guest, False otherwise. |
boolean |
keySource |
||
newCreated |
True, if the key was created during this request with the "create" parameter set. |
boolean |
newKey |
True, if the key was created during this request with the "create" parameter set. Also True if the "create" parameter is missing but the key would have been created with the parameter present. |
boolean |
publicRing |