Cloud-Plugins Rest APIs (1.11.4)

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&quo