Download OpenAPI specification:Download
Documentation of the Open-Xchange Cloud-Plugins Rest APIs.
change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| custom | string 1 items |
{- "custom": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| msisdn | string 1 items |
{- "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 |
put parameters
| classofservice | Array of strings non-empty |
{- "classofservice": [
- "string"
]
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "classofservice": "cloud_pim"
}get uidname of user
| search required | string string to search for |
| field | string Enum: "UIDNAME" "MSISDN" "OXDELIVERYSTATUS" "CUSTOM" "ANY" field to search into |
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| oxdeliverystatus | string 1 items |
{- "oxdeliverystatus": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| oxlegacyref | string 1 items |
{- "oxlegacyref": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "oxlegacyref": "LEG_1"
}get the oxantiphishing flag of user to determine MTA level antiphishing support
| contextid required | number context id |
| userid required | number user id |
{- "oxantiphishing": "replace-urls"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| oxantiphishing | string 1 items |
{- "oxantiphishing": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxantiphishing": "replace-urls"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| uidname | string 1 items |
{- "uidname": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}change user data
| contextid required | number context id |
| userid required | number user id |
post parameters
| msisdn | string >= 0 items |
| oxdeliverystatus | string >= 0 items |
| custom | Array of strings >= 0 items |
{- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS",
- "custom": [
- "id 1",
- "id 2"
]
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}change the users' antivirus state
| contextid required | number context id |
| userid required | number user id |
put parameters
| antivirus | boolean |
{- "antivirus": true
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}change the users' spamlevel
| contextid required | number context id |
| userid required | number user id |
put parameters
| spamlevel | string |
{- "spamlevel": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}list users within a context
| contextid required | number context id |
| uids | string comma separated list of uids of the users to return or all users if omitted |
{- "oxadmin": {
- "classofservice": [ ],
- "context-id": 57,
- "oxantiphishing": "MISSING",
- "quota-object-count": 0,
- "quota-usage": 0,
- "quotamode": "default",
- "spamlevel": "medium",
- "is-user-admin": false,
- "uidname": "oxadmin",
- "user-id": 2
}, - "testuser": {
- "classofservice": [
- "cosName=cloud_pim,ou=services,o=oxcs"
], - "context-id": 57,
- "max-quota": 800,
- "oxantiphishing": "MISSING",
- "oxdeliverystatus": "OXAAS",
- "quota-object-count": 60,
- "quota-usage": 99155678,
- "quotamode": "unified",
- "spamlevel": "high",
- "is-user-admin": false,
- "uidname": "testuser",
- "user-id": 3
}
}Close all user sessions or all sessions within a single context or of a specific user within a context. When no further user selection criterion is specified, then all the sessions of all the users within the context will be removed.
| contextId | string Id of the context to choose |
| contextName | string Name of the context to choose |
| userId | string The numeric and internal oxUserId reference |
| userName | string The unique name of the user |
| userMail | string One of the email addresses of the user. Since it is generally strongly recommended to not use the internal reference numbers, use the userName or userMail options unless the userId has already been resolved through other means. |
{- "closed": [
- "06e1e366951c379cb778e4b301327af9",
- "14bfc82d1bd6e62b2cf34cff5c126c64"
]
}retrieve brand name(s) of the given contextid; if brand is a sub-brand, toplevel brand is returned as well
| contextid required | number context id |
{- "brandname": "a.sub.brand",
- "toplevel-brand": "a.toplevel.brand"
}get the is-user-admin flag of a user to determine whether that user is allowed to perform provisioning operations on their context
| contextid required | number context id |
| userid required | number user id |
{- "is-user-admin": true
}change the context provisiong admin flag os a user
| contextid required | number context id |
| userid required | number user id |
put parameters
| is-user-admin | boolean 1 items |
{- "is-user-admin": true
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxantiphishing": "replace-urls",
- "is-user-admin": false
}create a forwarding alias or completely replace it with the given value
| contextId required | string context id or context name |
| alias required | string alias mail address |
| recipient | string 1 items |
{- "recipient": "recipient1@example.com"
}nulladd the given recipient(s) to the existing ones
| contextId required | string context id or context name |
| alias required | string alias mail address |
| recipient | string 1 items |
{- "recipient": "recipient1@example.com"
}nullget the forwarding Aliases in a Context
| contextId required | string context id or context name |
{- "alias@example.com": [
- "recipient1@example.com"
], - "alias2@example.com": [
- "recipient2@example.com"
]
}check 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 |
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 |
nullget all data in one request
| uid required | string user identifier |
{- "recentmails": [
- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
], - "quota": {
- "mailQuota": {
- "usedQuota": 0,
- "maxQuota": 0
}
}, - "newmessages": {
- "newmessages": 0
}, - "recentmessages": {
- "newmessages": 0
}
}get 5 recent mails from user in INBOX
| uid required | string user identifier |
[- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
]Retrieve all users with aliases using the given domain
| domain required | string Domain name |
{- "users": [
- {
- "context-id": 42,
- "uidname": "janedoe",
- "aliases": [
- "jane@example.com"
]
}
]
}Get the filtered blacklist for user
| contextId required | number context id |
| userid required | number user id |
| filter required | string the blacklist filter which can contain wildcard * |
{- "blacklist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}Get the filtered whitelist for user
| contextId required | number context id |
| userid required | number user id |
| filter required | string the whitelist filter which can contain wildcard * |
{- "whitelist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}Send an "over quota" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
the user quota threshold
| quota_threshold | number |
{- "quota_threshold": 1000
}{- "mail": "the message content"
}Send an "over quota" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
the user quota threshold
| quota_threshold | number |
{- "quota_threshold": 1000
}{- "mail": "the message content"
}Send a "disabled send from sending spam" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
3@4 has no primary mail address
Send a "welcome" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
{- "mail": "the message content"
}Create new announcement
| id | integer |
| version | integer |
| name | string |
| msgJsonObject | object |
| startDatetime | string <date-time> |
| endDatetime | string <date-time> |
| timezone | string; |
| discardable | boolean |
| enabled | boolean |
| ownerBrand | string |
| brands | Array of strings |
{- "application/json": {
- "brands": [
- "example.com"
], - "discardable": true,
- "enabled": true,
- "msgJsonObject": {
- "defaultLang": "de",
- "msgsByLang": {
- "de": {
- "message": "Spater hutete zur labsal nah sohlen leisen schale. Zog ige vorpfeifen ist bangigkeit wir eigentlich todesfalle. So la im warmen em freude drohte schade lustig. ",
- "summary": "Bald ist Weihnachten"
}, - "en": {
- "message": "As it so contrasted oh estimating instrument. Size like body some one had. Are conduct viewing boy minutes warrant expense. ",
- "summary": "It's Christmas, soon"
}
}
}, - "name": "The first November Announcement",
- "startDatetime": "2021-11-08T10:00:00",
- "endDatetime": "2021-11-15T10:00:00",
- "timezone": "Europe/Berlin"
}
}{- "error": "Error message"
}[- {
- "brands": [
- "example.com"
], - "discardable": true,
- "enabled": true,
- "endDatetime": "2021-11-15T10:00:00",
- "id": 1,
- "msgJsonObject": {
- "defaultLang": "de",
- "msgsByLang": {
- "de": {
- "message": "Spater hutete zur labsal nah sohlen leisen schale. Zog ige vorpfeifen ist bangigkeit wir eigentlich todesfalle. So la im warmen em freude drohte schade lustig. ",
- "summary": "Bald ist Weihnachten"
}, - "en": {
- "message": "As it so contrasted oh estimating instrument. Size like body some one had. Are conduct viewing boy minutes warrant expense. ",
- "summary": "It's Christmas, soon"
}
}
}, - "name": "The first November Announcement",
- "ownerBrand": "example.com",
- "startDatetime": "2021-11-08T10:00:00",
- "timezone": "Europe/Berlin",
- "version": 1
}
]Update an existing announcement
| id required | number Announcement id |
| id | integer |
| version | integer |
| name | string |
| msgJsonObject | object |
| startDatetime | string <date-time> |
| endDatetime | string <date-time> |
| timezone | string; |
| discardable | boolean |
| enabled | boolean |
| ownerBrand | string |
| brands | Array of strings |
{- "application/json": {
- "brands": [
- "example.com"
], - "discardable": true,
- "enabled": true,
- "id": 1,
- "msgJsonObject": {
- "defaultLang": "de",
- "msgsByLang": {
- "de": {
- "message": "Spater hutete zur labsal nah sohlen leisen schale. Zog ige vorpfeifen ist bangigkeit wir eigentlich todesfalle. So la im warmen em freude drohte schade lustig. ",
- "summary": "Bald ist Weihnachten"
}, - "en": {
- "message": "As it so contrasted oh estimating instrument. Size like body some one had. Are conduct viewing boy minutes warrant expense. ",
- "summary": "It's Christmas, soon"
}
}
}, - "name": "The first November Announcement",
- "startDatetime": "2021-11-08T10:00:00",
- "endDatetime": "2021-11-15T10:00:00",
- "timezone": "Europe/Berlin"
}
}{- "error": "Error message"
}