Cloud-Plugins Rest APIs (1.11.9)

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 /oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

get custom name of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or custom id not found in user

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "custom":
    [
    ]
}

change custom id(s)

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

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

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "custom": "string"
}

Response samples

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

delete custom id(s)

delete /oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

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

get msisdn of user

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

get msisdn of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or msisdn not set for user

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "msisdn": "+49.12345.6789"
}

change msisdn

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/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

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "msisdn": "string"
}

Response samples

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

delete msisdn

delete /oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

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

get class of service of user

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice

get class of service of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or msisdn not set for user

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "classofservice": "cloud_pim"
}

change class of service

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

classofservice
string 1 items

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "classofservice": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "classofservice": "cloud_pim"
}

delete class of service

delete /oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com"
}

search for users using given query parameters

get /oxaas/v1/admin/oxuser
http://example.com/oxaas/v1/admin/oxuser
https://example.com/oxaas/v1/admin/oxuser

get uidname of user

Authorizations:
query Parameters
search
required
string

string to search for

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

field to search into

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User not found

Response samples

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

get the oxdeliverystatus

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus

get the oxdeliverystatus of user to determine migration status

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or oxdeliverystatus not set for user

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "oxdeliverystatus": "OXAAS"
}

change oxdeliverystatus

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

oxdeliverystatus
string 1 items

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "oxdeliverystatus": "string"
}

Response samples

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

delete oxdeliverystatus

delete /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

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

get the oxlegacyref

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref

get the oxlegacyref of user to determine migration status

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or oxlegacyref not set for user

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "oxlegacyref": "LEG_1"
}

change oxlegacyref

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

oxlegacyref
string 1 items

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "oxlegacyref": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "oxlegacyref": "LEG_1"
}

delete oxlegacyref

delete /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com"
}

get the oxantiphishing

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing

get the oxantiphishing flag of user to determine MTA level antiphishing support

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or oxantiphishing not set for user

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "oxantiphishing": "replace-urls"
}

change oxantiphishing

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

oxantiphishing
string 1 items

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "oxantiphishing": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "user-id": 42,
  • "uidname": "johndoe@example.com",
  • "msisdn": "+49.12345.6789",
  • "oxantiphishing": "replace-urls"
}

delete oxantiphishing

delete /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

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

get uidname of user

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname

get uidname of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist

Response samples

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

change uidname

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/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

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

409

User does already exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "uidname": "string"
}

Response samples

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

change or remove msisdn or custom id(s)

post /oxaas/v1/admin/contexts/{contextid}/users/{userid}/uids
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uids
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uids

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
oxdeliverystatus
string >= 0 items
custom
Array of strings >= 0 items

Responses

200

Settings successfully updated

201

At least one setting has been created

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "msisdn": "+49.12345.6789",
  • "oxdeliverystatus": "OXAAS",
  • "custom":
    [
    ]
}

Response samples

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

get the antivirus state

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus

get the antivirus state

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "antivirus": true
}

Change antivirus state

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus

change the users' antivirus state

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

antivirus
boolean

Responses

200

Settings successfully updated

400

Generic error, e.g. missing or wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "antivirus": true
}

Response samples

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

get the spamlevel

get /oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel

get the spamlevel

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spamlevel": "medium"
}

Change spamlevel

put /oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel
http://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel
https://example.com/oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel

change the users' spamlevel

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json

put parameters

spamlevel
string

Responses

200

Settings successfully updated

400

Generic error, e.g. missing or wrong parameters

401

Authorization error

404

User does not exist

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spamlevel": "string"
}

Response samples

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

Forwards

Cloud-Plugins Admin Forwards Rest API

get the forwarding Alias

get /api/oxaas/v1/admin/forwards/{contextId}/{alias}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}

get the forwarding Alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Responses

200

Success

403

Authorization error

404

Forwarding alias does not exist or context not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • "recipient1@example.com"
]

create the forwarding Alias

post /api/oxaas/v1/admin/forwards/{contextId}/{alias}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{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

201

Success

204

if already exists (without making any changes to the recipients)

403

Authorization error

404

Context not found

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "recipient": "recipient@example.com"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

update the forwarding Alias

put /api/oxaas/v1/admin/forwards/{contextId}/{alias}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{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

201

Success

204

if already exists (without making any changes to the recipients)

400

if there is a value present for the forwarding recipient

403

Authorization error

404

Forwarding alias does not exist or context not found

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "recipient": "recipient@example.com"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

delete the forwarding Alias

delete /api/oxaas/v1/admin/forwards/{contextId}/{alias}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}

delete the forwarding Alias

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Responses

204

Success

403

Authorization error

404

Forwarding alias does not exist or context not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

check if the alias exists

head /api/oxaas/v1/admin/forwards/{contextId}/{alias}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}

check if the alias exists

Authorizations:
path Parameters
contextId
required
string

context id or context name

alias
required
string

alias mail address

Responses

200

Alias exists

403

Authorization error

404

Forwarding alias does not exist or context not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

get the forwarding Aliases in a Context

get /api/oxaas/v1/admin/forwards/{contextId}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}

get the forwarding Aliases in a Context

Authorizations:
path Parameters
contextId
required
string

context id or context name

Responses

200

Success

403

Authorization error

404

Context not found

Response samples

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

delete all forwarding Aliases in a context

delete /api/oxaas/v1/admin/forwards/{contextId}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}

delete all forwarding Aliases in a context

Authorizations:
path Parameters
contextId
required
string

context id or context name

Responses

204

Success

403

Authorization error

404

Context not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

check if a recipient for an alias exists

head /api/oxaas/v1/admin/forwards/{contextId}/{alias}/{recipient}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}/{recipient}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}/{recipient}

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

200

Alias exists

403

Authorization error

404

Forwarding alias does not exist or context not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

delete the recipient of an alias

delete /api/oxaas/v1/admin/forwards/{contextId}/{alias}/{recipient}
http://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}/{recipient}
https://example.com/api/oxaas/v1/admin/forwards/{contextId}/{alias}/{recipient}

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

204

Success

403

Authorization error

404

Forwarding alias does not exist or context not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

Mail

Cloud-Plugins Mail Rest API

get all data in one request

get /api/oxaas/mail/{uid}
http://example.com/api/oxaas/mail/{uid}
https://example.com/api/oxaas/mail/{uid}

get all data in one request

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

200

Success

401

Authorization error

500

General Error

Response samples

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

get the number of new messages since last login in

get /api/oxaas/mail/{uid}/newmessages
http://example.com/api/oxaas/mail/{uid}/newmessages
https://example.com/api/oxaas/mail/{uid}/newmessages

get the number of new messages since last login in INBOX

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

200

Success

401

Authorization error

500

General Error

Response samples

Content type
Copy
Expand all Collapse all
{
  • "newmessages": 0
}

get the current user quota

get /api/oxaas/mail/{uid}/quota
http://example.com/api/oxaas/mail/{uid}/quota
https://example.com/api/oxaas/mail/{uid}/quota

get the current user quota

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

200

Success

401

Authorization error

500

General Error

Response samples

Content type
Copy
Expand all Collapse all
{
  • "mailQuota":
    {
    }
}

get 5 recent mails from user in INBOX

get /api/oxaas/mail/{uid}/recentmails
http://example.com/api/oxaas/mail/{uid}/recentmails
https://example.com/api/oxaas/mail/{uid}/recentmails

get 5 recent mails from user in INBOX

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

200

Success

401

Authorization error

500

General Error

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

get the number of unread mails in all folders

get /api/oxaas/mail/{uid}/recentmessages
http://example.com/api/oxaas/mail/{uid}/recentmessages
https://example.com/api/oxaas/mail/{uid}/recentmessages

get the number of unread mails in all folders

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

200

Success

401

Authorization error

500

General Error

Response samples

Content type
Copy
Expand all Collapse all
{
  • "newmessages": 0
}

get the unread message count from INBOX for user

get /api/oxaas/mail/unread/{uid}
http://example.com/api/oxaas/mail/unread/{uid}
https://example.com/api/oxaas/mail/unread/{uid}

get the unread message count from INBOX for user

Authorizations:
path Parameters
uid
required
string

user identifier

Responses

200

Success

401

Authorization error

500

General Error

Response samples

Content type
Copy
Expand all Collapse all
{
  • "newmessages": 0
}

Explicit Domains

Cloud-Plugins Explicit Domain management

Check whether given domain exists in context

head /api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}
http://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}
https://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}

Check whether given domain exists in context

Authorizations:
path Parameters
contextid
required
number

Id of context

domain
required
string

Name of explicit domain

Responses

200

Domain exists

400

Generic error, e.g. wrong parameters

401

Authorization error

404

Domain does not exist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "error": "Error message"
}

Create given domain in context

post /api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}
http://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}
https://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}

Create given domain in context

Authorizations:
path Parameters
contextid
required
number

Id of context

domain
required
string

Name of explicit domain

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

409

Domain could not be added

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "domain": "example.com"
}

Remove given domain from context

delete /api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}
http://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}
https://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}

Remove given domain from context

Authorizations:
path Parameters
contextid
required
number

Id of context

domain
required
string

Name of explicit domain

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

409

Domain could not be removed

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "error": "Error message"
}

List all explicit mail domains within given contex

get /api/oxaas/v1/admin/explicitmaildomains/{contextid}
http://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}
https://example.com/api/oxaas/v1/admin/explicitmaildomains/{contextid}

List all explicit mail domains within given context

Authorizations:
path Parameters
contextid
required
number

Id of context

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "domains":
    [
    ]
}

Check whether given domain exists in brand

head /api/oxaas/v1/admin/explicitmaildomains/{domain}
http://example.com/api/oxaas/v1/admin/explicitmaildomains/{domain}
https://example.com/api/oxaas/v1/admin/explicitmaildomains/{domain}

Check whether given domain exists in brand

Authorizations:
path Parameters
domain
required
string

Name of explicit domain

Responses

200

Domain exists

400

Generic error, e.g. wrong parameters

401

Authorization error

404

Domain does not exist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "error": "Error message"
}

List all explicit mail domains owned by brand

get /api/oxaas/v1/admin/explicitmaildomains/*
http://example.com/api/oxaas/v1/admin/explicitmaildomains/*
https://example.com/api/oxaas/v1/admin/explicitmaildomains/*

List all explicit mail domains owned by brand

Authorizations:

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "domains":
    [
    ]
}

Retrieve all users with aliases using the given do

get /api/oxaas/v1/admin/explicitmaildomains/{domain}/users
http://example.com/api/oxaas/v1/admin/explicitmaildomains/{domain}/users
https://example.com/api/oxaas/v1/admin/explicitmaildomains/{domain}/users

Retrieve all users with aliases using the given domain

Authorizations:
path Parameters
domain
required
string

Domain name

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "users":
    [
    ]
}

Shared Domains

Cloud-Plugins Shared Domain management

Check if shared domain exists

head /api/oxaas/v1/admin/sharedmaildomains/{domain}
http://example.com/api/oxaas/v1/admin/sharedmaildomains/{domain}
https://example.com/api/oxaas/v1/admin/sharedmaildomains/{domain}

Check if shared domain exists

Authorizations:

Responses

200

Domain exists

401

Authorization error

404

Domain does not exist

Response samples

Content type
Copy
Expand all Collapse all
null

Create given shared domain

post /api/oxaas/v1/admin/sharedmaildomains/{domain}
http://example.com/api/oxaas/v1/admin/sharedmaildomains/{domain}
https://example.com/api/oxaas/v1/admin/sharedmaildomains/{domain}

Create given shared domain

Authorizations:
path Parameters
domain
required
string

Name of shared domain

Responses

200

Success

401

Authorization error

403

Domain could not be added

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "domain": "example.com"
}

Remove given shared domain

delete /api/oxaas/v1/admin/sharedmaildomains/{domain}
http://example.com/api/oxaas/v1/admin/sharedmaildomains/{domain}
https://example.com/api/oxaas/v1/admin/sharedmaildomains/{domain}

Remove given shared domain

Authorizations:
path Parameters
domain
required
string

Name of shared domain

Responses

200

Success

401

Authorization error

403

Domain could not be removed

404

Shared domain not found

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

List all shared shared domains owned by brand

get /api/oxaas/v1/admin/sharedmaildomains/*
http://example.com/api/oxaas/v1/admin/sharedmaildomains/*
https://example.com/api/oxaas/v1/admin/sharedmaildomains/*

List all shared shared domains owned by brand

Authorizations:

Responses

200

Success

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "domains":
    [
    ]
}

Black And White Lists

Cloud-Plugins Black and White Lists management

Get the blacklist for user

get /oxaas/v1/admin/blacklist/{contextid}/{userid}
http://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}
https://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}

Get the blacklist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "blacklist":
    [
    ]
}

Delete the blacklist for user

delete /oxaas/v1/admin/blacklist/{contextid}/{userid}
http://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}
https://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}

Delete the blacklist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

Get the filtered blacklist for user

get /oxaas/v1/admin/blacklist/{contextid}/{userid}/{filter}
http://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}/{filter}
https://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}/{filter}

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

200

Success

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "blacklist":
    [
    ]
}

Add blacklist entry for user

put /oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}
http://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}
https://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}

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

200

Success

401

Authorization error

Delete blacklist entry for user

delete /oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}
http://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}
https://example.com/oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}

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

200

Success

401

Authorization error

Get the whitelist for user

get /oxaas/v1/admin/whitelist/{contextid}/{userid}
http://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}
https://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}

Get the whitelist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "whitelist":
    [
    ]
}

Delete the whitelist for user

delete /oxaas/v1/admin/whitelist/{contextid}/{userid}
http://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}
https://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}

Delete the whitelist for user

Authorizations:
path Parameters
contextId
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

Get the filtered whitelist for user

get /oxaas/v1/admin/whitelist/{contextid}/{userid}/{filter}
http://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}/{filter}
https://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}/{filter}

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

200

Success

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "whitelist":
    [
    ]
}

Add whitelist entry for user

put /oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}
http://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}
https://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}

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

200

Success

401

Authorization error

Delete whitelist entry for user

delete /oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}
http://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}
https://example.com/oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}

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

200

Success

401

Authorization error

Notification

Cloud-Plugins Notification Rest API

Send an "over quota" mail to user

post /api/oxaas/notification/mail/{usercontext}
http://example.com/api/oxaas/notification/mail/{usercontext}
https://example.com/api/oxaas/notification/mail/{usercontext}

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

200

Success

400

When quota threshold or usercontext are not provided

401

Authorization error

406

No acceptable variant

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "quota_threshold": 1000
}

Response samples

Content type
Copy
Expand all Collapse all
{
  • "mail": "the message content"
}

Send an "over quota" mail to user

post /api/oxaas/notification/mail/quota/{usercontext}
http://example.com/api/oxaas/notification/mail/quota/{usercontext}
https://example.com/api/oxaas/notification/mail/quota/{usercontext}

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

200

Success

400

When quota threshold or usercontext are not provided

401

Authorization error

406

No acceptable variant

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "quota_threshold": 1000
}

Response samples

Content type
Copy
Expand all Collapse all
{
  • "mail": "the message content"
}

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

post /api/oxaas/notification/mail/disable_sent_spam_notification/{usercontext}
http://example.com/api/oxaas/notification/mail/disable_sent_spam_notification/{usercontext}
https://example.com/api/oxaas/notification/mail/disable_sent_spam_notification/{usercontext}

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

200

Success

400

When usercontext is not provided

401

Authorization error

412

When the primary mail account cannot be found

500

General error

Response samples

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

Send a "welcome" mail to user

post /api/oxaas/notification/mail/welcomemail/{usercontext}
http://example.com/api/oxaas/notification/mail/welcomemail/{usercontext}
https://example.com/api/oxaas/notification/mail/welcomemail/{usercontext}

Send a "welcome" mail to user

Authorizations:
path Parameters
usercontext
required
string

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

Responses

200

Success

400

When usercontext is not provided

401

Authorization error

406

No acceptable variant

Response samples

Content type
Copy
Expand all Collapse all
{
  • "mail": "the message content"
}

Announcements

Rest API to manage announcements shown to users

Create new announcement

post /api/oxaas/v1/admin/announcements
http://example.com/api/oxaas/v1/admin/announcements
https://example.com/api/oxaas/v1/admin/announcements

Create new announcement

Authorizations:
Request Body schema: application/json
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

Responses

201

Created

400

Generic error, e.g. wrong parameters

401

Authorization error

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "application/json":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "error": "Error message"
}

List all announcements

get /api/oxaas/v1/admin/announcements/*
http://example.com/api/oxaas/v1/admin/announcements/*
https://example.com/api/oxaas/v1/admin/announcements/*

List all announcements

Authorizations:

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Delete an existing announcement

delete /api/oxaas/v1/admin/announcements/{id}
http://example.com/api/oxaas/v1/admin/announcements/{id}
https://example.com/api/oxaas/v1/admin/announcements/{id}

Delete an existing announcement

Authorizations:
path Parameters
id
required
number

Announcement id

Responses

204

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
No sample

Update an existing announcement

put /api/oxaas/v1/admin/announcements/update/{id}
http://example.com/api/oxaas/v1/admin/announcements/update/{id}
https://example.com/api/oxaas/v1/admin/announcements/update/{id}

Update an existing announcement

Authorizations:
path Parameters
id
required
number

Announcement id

Request Body schema: application/json
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

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "application/json":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "error": "Error message"
}

Enable an existing announcement

put /api/oxaas/v1/admin/announcements/enable/{id}
http://example.com/api/oxaas/v1/admin/announcements/enable/{id}
https://example.com/api/oxaas/v1/admin/announcements/enable/{id}

Enable an existing announcement

Authorizations:
path Parameters
id
required
number

Announcement id

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
No sample

Disable an existing announcement

put /api/oxaas/v1/admin/announcements/diable/{id}
http://example.com/api/oxaas/v1/admin/announcements/diable/{id}
https://example.com/api/oxaas/v1/admin/announcements/diable/{id}

Disable an existing announcement

Authorizations:
path Parameters
id
required
number

Announcement id

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

Response samples

Content type
No sample