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