Download OpenAPI specification:Download
Documentation of the Open-Xchange Cloud-Plugins Rest APIs.
get custom name of user
| contextid required | number context id |
| userid required | number user id |
Success
Authorization error
User does not exist or custom id not found in user
{- "custom": [
- "custom1",
- "custom2"
]
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| custom | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "custom": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}get msisdn of user
| contextid required | number context id |
| userid required | number user id |
Success
Authorization error
User does not exist or msisdn not set for user
{- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| msisdn | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "msisdn": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}get uidname of user
| search required | string string to search for |
| field | string Enum: "UIDNAME" "MSISDN" "CUSTOM" "ANY" field to search into |
Success
Generic error, e.g. wrong parameters
Authorization error
User not found
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}get uidname of user
| contextid required | number context id |
| userid required | number user id |
Success
Authorization error
User does not exist
{- "uidname": "johndoe@example.com"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| uidname | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
User does already exist
{- "uidname": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
post parameters
| msisdn | string >= 0 items |
| custom | Array of strings >= 0 items |
Settings successfully updated
At least one setting has been created
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "msisdn": "+49.12345.6789",
- "custom": [
- "id 1",
- "id 2"
]
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}get whole config of the user
| contextid required | number context id |
| userid required | number user id |
Success
Authorization error
User does not exist
{- "userconfig": [
- {
- "name": "com.openexchange.first.config",
- "scope": "server",
- "value": "true"
}, - {
- "name": "com.openexchange.second.config",
- "scope": "user",
- "value": "false"
}
]
}get whole config of the user
| contextid required | number context id |
| userid required | number user id |
| searchpattern required | string Search Pattern to filter the list of returned configurations |
Success
Authorization error
User does not exist
{- "userconfig": [
- {
- "name": "com.openexchange.filtered.config.1",
- "scope": "server",
- "value": "true"
}, - {
- "name": "com.openexchange.filtered.config.2",
- "scope": "user",
- "value": "false"
}
]
}get the forwarding Alias
| contextId required | string context id or context name |
| alias required | string alias mail address |
Success
Authorization error
Forwarding alias does not exist or context not found
[- "recipient1@example.com"
]create the forwarding Alias
| contextId required | string context id or context name |
| alias required | string alias mail address |
post parameters
| recipient | string 1 items |
Success
if already exists (without making any changes to the recipients)
Authorization error
Context not found
{- "recipient": "recipient@example.com"
}nullupdate the forwarding Alias
| contextId required | string context id or context name |
| alias required | string alias mail address |
post parameters
| recipient | string 1 items |
Success
if already exists (without making any changes to the recipients)
if there is a value present for the forwarding recipient
Authorization error
Forwarding alias does not exist or context not found
{- "recipient": "recipient@example.com"
}nulldelete the forwarding Alias
| contextId required | string context id or context name |
| alias required | string alias mail address |
Success
Authorization error
Forwarding alias does not exist or context not found
nullcheck if the alias exists
| contextId required | string context id or context name |
| alias required | string alias mail address |
Alias exists
Authorization error
Forwarding alias does not exist or context not found
nullget the forwarding Aliases in a Context
| contextId required | string context id or context name |
Success
Authorization error
Context not found
{- "alias@example.com": [
- "recipient1@example.com"
], - "alias2@example.com": [
- "recipient2@example.com"
]
}delete all forwarding Aliases in a context
| contextId required | string context id or context name |
Success
Authorization error
Context not found
nullcheck if a recipient for an alias exists
| contextId required | string context id or context name |
| alias required | string alias mail address |
| recipient required | string recipient mail address |
Alias exists
Authorization error
Forwarding alias does not exist or context not found
nulldelete the recipient of an alias
| contextId required | string context id or context name |
| alias required | string alias mail address |
| recipient required | string recipient mail address |
Success
Authorization error
Forwarding alias does not exist or context not found
nullget all data in one request
| uid required | string user identifier |
Success
Authorization error
General Error
{- "recentmails": [
- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
], - "quota": {
- "mailQuota": {
- "usedQuota": 0,
- "maxQuota": 0
}
}, - "newmessages": {
- "newmessages": 0
}, - "recentmessages": {
- "newmessages": 0
}
}get the number of new messages since last login
| uid required | string user identifier |
Success
Authorization error
General Error
{- "newmessages": 0
}get the current user quota
| uid required | string user identifier |
Success
Authorization error
General Error
{- "mailQuota": {
- "usedQuota": 0,
- "maxQuota": 0
}
}get 5 recent mails from user
| uid required | string user identifier |
Success
Authorization error
General Error
[- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
]get the number of unread mails in all folders
| uid required | string user identifier |
Success
Authorization error
General Error
{- "newmessages": 0
}