Cloud-Plugins Rest APIs (1.9.2)

Download OpenAPI specification:Download

Documentation of the Open-Xchange Cloud-Plugins Rest APIs.

Authentication

basicAuth

HTTP Basic Authentication.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

contextAdminAuth

The API can be accessed via HTTP Basic Auth with context administrator credentials or reseller/master administrator credentials if MASTER_ACCOUNT_OVERRIDE is enabled.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

contextAdminOnlyAuth

The API can be accessed via HTTP Basic Auth with context administrator credentials or reseller administrator.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

resellerAdminAuth

The API can be accessed via HTTP Basic Auth with reseller/master administrator credentials if MASTER_ACCOUNT_OVERRIDE is enabled. Context administrator access is not possible.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

tennantAuth

Basic auth, that must be configured per tenant in the middleware

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Admin

Cloud-Plugins Admin Rest API

get custom name of user

get custom name of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "custom": [
    ]
}

change custom id(s)

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

custom
string 1 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

delete custom id(s)

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

get msisdn of user

get msisdn of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "msisdn": "+49.12345.6789"
}

change msisdn

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

msisdn
string 1 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

delete msisdn

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

search for users using given query parameters

get uidname of user

Authorizations:
query Parameters
search
required
string

string to search for

field
string
Enum: "UIDNAME" "MSISDN" "CUSTOM" "ANY"

field to search into

Responses

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

get uidname of user

get uidname of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "uidname": "johndoe@example.com"
}

change uidname

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

uidname
string 1 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

change or remove msisdn or custom id(s)

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

post parameters

msisdn
string >= 0 items
custom
Array of strings >= 0 items

Responses

Request samples

Content type
application/json
{
  • "msisdn": "+49.12345.6789",
  • "custom": [
    ]
}

Response samples

Content type
application/json
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789"
}

get whole config of the user

get whole config of the user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "userconfig": [
    ]
}

get whole config of the user

get whole config of the user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

searchpattern
required
string

Search Pattern to filter the list of returned configurations

Responses

Response samples

Content type
application/json
{
  • "userconfig": [
    ]
}

Forwards

Cloud-Plugins Admin Forwards Rest API

get the forwarding Alias

get the forwarding Alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Responses

Response samples

Content type
application/json
[
  • "recipient1@example.com"
]

create the forwarding Alias

create the forwarding Alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Request Body schema: application/json

post parameters

recipient
string 1 items

Responses

Request samples

Content type
application/json
{
  • "recipient": "recipient@example.com"
}

Response samples

Content type
application/json
null

update the forwarding Alias

update the forwarding Alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Request Body schema: application/json

post parameters

recipient
string 1 items

Responses

Request samples

Content type
application/json
{
  • "recipient": "recipient@example.com"
}

Response samples

Content type
application/json
null

delete the forwarding Alias

delete the forwarding Alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Responses

Response samples

Content type
application/json
null

check if the alias exists

check if the alias exists

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Responses

Response samples

Content type
application/json
null

get the forwarding Aliases in a Context

get the forwarding Aliases in a Context

Authorizations:
path Parameters
contextId
required
string

context id or context name

Responses

Response samples

Content type
application/json
{
  • "alias@example.com": [
    ],
  • "alias2@example.com": [
    ]
}

delete all forwarding Aliases in a context

delete all forwarding Aliases in a context

Authorizations:
path Parameters
contextId
required
string

context id or context name

Responses

Response samples

Content type
application/json
null

check if a recipient for an alias exists

check if a recipient for an alias exists

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

recipient
required
string

recipient mail address

Responses

Response samples

Content type
application/json
null

delete the recipient of an alias

delete the recipient of an alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

recipient
required
string

recipient mail address

Responses

Response samples

Content type
application/json
null

Mail

Cloud-Plugins Mail Rest API

get all data in one request

get all data in one request

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

Response samples

Content type
application/json
{
  • "recentmails": [
    ],
  • "quota": {
    },
  • "newmessages": {
    },
  • "recentmessages": {
    }
}

get the number of new messages since last login

get the number of new messages since last login

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

Response samples

Content type
{
  • "newmessages": 0
}

get the current user quota

get the current user quota

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

Response samples

Content type
{
  • "mailQuota": {
    }
}

get 5 recent mails from user

get 5 recent mails from user

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

Response samples

Content type
[
  • {
    }
]

get the number of unread mails in all folders

get the number of unread mails in all folders

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

Response samples

Content type
{
  • "newmessages": 0
}

get the unread message count from INBOX for user

get the unread message count from INBOX for user

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

Response samples

Content type
{
  • "newmessages": 0
}

Explicit Domains

Cloud-Plugins Explicit Domain management

Check whether given domain exists in context

Check whether given domain exists in context

Authorizations:
path Parameters
contextid
required
number

Id of context

domain
required
string

Name of explicit domain

Responses

Response samples

Content type
application/json
{
  • "error": "Error message"
}

Create given domain in context

Create given domain in context

Authorizations:
path Parameters
contextid
required
number

Id of context

domain
required
string

Name of explicit domain

Responses

Response samples

Content type
application/json
{
  • "domain": "example.com"
}

Remove given domain from context

Remove given domain from context

Authorizations:
path Parameters
contextid
required
number

Id of context

domain
required
string

Name of explicit domain

Responses

Response samples

Content type
application/json
{
  • "error": "Error message"
}

List all explicit mail domains within given contex

List all explicit mail domains within given context

Authorizations:
path Parameters
contextid
required
number

Id of context

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Check whether given domain exists in brand

Check whether given domain exists in brand

Authorizations:
path Parameters
domain
required
string

Name of explicit domain

Responses

Response samples

Content type
application/json
{
  • "error": "Error message"
}

List all explicit mail domains owned by brand

List all explicit mail domains owned by brand

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Retrieve all users with aliases using the given do

Retrieve all users with aliases using the given domain

Authorizations:
path Parameters
domain
required
string

Domain name

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Shared Domains

Cloud-Plugins Shared Domain management

Check if shared domain exists

Check if shared domain exists

Authorizations:

Responses

Response samples

Content type
null

Create given shared domain

Create given shared domain

Authorizations:
path Parameters
domain
required
string

Name of shared domain

Responses

Response samples

Content type
application/json
{
  • "domain": "example.com"
}

Remove given shared domain

Remove given shared domain

Authorizations:
path Parameters
domain
required
string

Name of shared domain

Responses

Response samples

Content type
application/json
null

List all shared shared domains owned by brand

List all shared shared domains owned by brand

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Black And White Lists

Cloud-Plugins Black and White Lists management

Get the blacklist for user

Get the blacklist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "blacklist": [
    ]
}

Delete the blacklist for user

Delete the blacklist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

Get the filtered blacklist for user

Get the filtered blacklist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

filter
required
string

the blacklist filter which can contain wildcard *

Responses

Response samples

Content type
application/json
{
  • "blacklist": [
    ]
}

Add blacklist entry for user

Add blacklist entry for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

value
required
string

entry to add

Responses

Delete blacklist entry for user

Delete blacklist entry for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

value
required
string

entry to delete

Responses

Get the whitelist for user

Get the whitelist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

Response samples

Content type
application/json
{
  • "whitelist": [
    ]
}

Delete the whitelist for user

Delete the whitelist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

Get the filtered whitelist for user

Get the filtered whitelist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

filter
required
string

the whitelist filter which can contain wildcard *

Responses

Response samples

Content type
application/json
{
  • "whitelist": [
    ]
}

Add whitelist entry for user

Add whitelist entry for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

value
required
string

entry to add

Responses

Delete whitelist entry for user

Delete whitelist entry for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

value
required
string

entry to delete

Responses

Notification

Cloud-Plugins Notification Rest API

Send an "over quota" mail to user

Send an "over quota" mail to user

Authorizations:
path Parameters
usercontext
required
string

the user context and user id in the form "userid@contextid"

Request Body schema: application/json

the user quota threshold

quota_threshold
number

Responses

Request samples

Content type
application/json
{
  • "quota_threshold": 1000
}

Response samples

Content type
{
  • "mail": "the message content"
}

Send an "over quota" mail to user

Send an "over quota" mail to user

Authorizations:
path Parameters
usercontext
required
string

the user context and user id in the form "userid@contextid"

Request Body schema: application/json

the user quota threshold

quota_threshold
number

Responses

Request samples

Content type
application/json
{
  • "quota_threshold": 1000
}

Response samples

Content type
{
  • "mail": "the message content"
}

Send a "disabled send from sending spam" mail to u

Send a "disabled send from sending spam" mail to user

Authorizations:
path Parameters
usercontext
required
string

the user context and user id in the form "userid@contextid"

Responses

Response samples

Content type
text/plain
3@4 has no primary mail address

Send a "welcome" mail to user

Send a "welcome" mail to user

Authorizations:
path Parameters
usercontext
required
string

the user context and user id in the form "userid@contextid"

Responses

Response samples

Content type
{
  • "mail": "the message content"
}