OX REST API (7.10.3)

Download OpenAPI specification:Download

Open-Xchange GmbH: info@open-xchange.com URL: https://www.open-xchange.com/

Documentation of the Open-Xchange REST API.

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

masterAdminAuth

The API can be accessed via HTTP Basic Auth with reseller/master administrator credentials.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

Userfeedback

The user feedback module

Exports user feedback

Authorizations:

basicAuth

path Parameters

context-group required	string Default: "default" The context group identifying the global DB where the feedback is stored.
type required	string Default: "star-rating-v1" The feedback type to send.

query Parameters

start	integer <int64> Start time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given after this time is sent. If not set, all feedback up to -e is sent.
end	integer <int64> End time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given before this time is sent. If not set, all feedback since -s is sent.

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

Exports user feedback as CSV

Authorizations:

basicAuth

path Parameters

context-group required	string Default: "default" The context group identifying the global DB where the feedback is stored.
type required	string Default: "star-rating-v1" The feedback type to send.

query Parameters

start	integer <int64> Start time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given after this time is sent. If not set, all feedback up to -e is sent.
end	integer <int64> End time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given before this time is sent. If not set, all feedback since -s is sent.
delimiter	string The column delimiter used. Default: ';'

Responses

Deletes user feedback

path Parameters

context-group required	string The context group identifying the global DB where the feedback is stored.
type required	string The feedback type to delete.

query Parameters

start	integer <int64> Start time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given after this time is deleted. If not set, all feedback up to -e is deleted.
end	integer <int64> End time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given before this time is deleted. If not set, all feedback since -s is deleted.

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

Exports user feedback and sends exported data to provided recipients

path Parameters

context-group required	string Default: "default" The context group identifying the global DB where the feedback is stored.
type required	string Default: "star-rating-v1" The feedback type to send.

query Parameters

start	integer <int64> Start time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given after this time is sent. If not set, all feedback up to -e is sent.
end	integer <int64> End time in milliseconds since 1970-01-01 00:00:00 UTC. Only feedback given before this time is sent. If not set, all feedback since -s is sent.

Request Body schema: application/json

JSONObject with fields "subject" for custom mail subject, "body" for custom mail body, boolean "compress" to compress the mail attachment and "recipients" (an JSON Array containing address, display name and PGP key (if available) for every recipient).

string

Responses

Request samples

Payload

Content type

application/json

"string"

Admin

Interface for provisioning and other administrative operations.

Close all sessions belonging to a context

Authorizations:

masterAdminAuth

query Parameters

global

boolean

Close sessions cluster-wide. Default: true

Request Body schema: application/json

A JSON object containing an array of context ids.

contextIds

Array of integers[ items ]

Array of context IDs

Responses

Request samples

Payload

Content type

application/json

{"contextIds": [0
]
}

Response samples

200

Content type

application/json

{"closed": ["string"
]
}

Close a session by its ID

Authorizations:

masterAdminAuth

query Parameters

global

boolean

Close sessions cluster-wide. Default: true

Request Body schema: application/json

A JSON object containing an array of session ids.

sessionIds

Array of strings

Array of session IDs

Responses

Request samples

Payload

Content type

application/json

{"sessionIds": ["string"
]
}

Close all sessions belonging to a user

Authorizations:

masterAdminAuth

query Parameters

global

boolean

Close sessions cluster-wide. Default: true

Request Body schema: application/json

A JSON object containing an array of user and context id tuples.

Array of objects (ContextUserTuple) [ items ]

Array of context/user id tuples

Responses

Request samples

Payload

Content type

application/json

{"users": [{"contextId": 0,
"userId": 0
}
]
}

Lists all multifactor authentication devices for a user.

Authorizations:

contextAdminAuth

path Parameters

context-id required	integer <int32> The context the user is in
user-id required	integer <int32> The ID representing the user

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"providerName": "string",
"enabled": true,
"backup": true
}
]

Deletes all multifactor authentication devices for a user.

Authorizations:

contextAdminAuth

path Parameters

context-id required	integer <int32> The context the user is in
user-id required	integer <int32> The ID representing the user

Responses

Lists the history of password changes for a user.

Authorizations:

contextAdminAuth

path Parameters

context-id required	integer <int32> The context the user is in
user-id required	integer <int32> The ID representing the user

query Parameters

limit	integer <int32> Limits the output to a specific number of entries.
sort	string Comma sperated list of fields to sort the output for. Field names that begin with "-" will be sorted descending else the fields get sorted ascending. Valid fields are 'date' and 'client_id'.

Responses

Response samples

200

Content type

application/json

[{"date": 0,
"client_id": "string",
"client_address": "string",
"client_name": "string"
}
]

Deletes a multifactor authentication device.

Authorizations:

contextAdminAuth

path Parameters

context-id required	integer <int32> The context the user is in
user-id required	integer <int32> The ID representing the user
provider-name required	string The name of the provider to delete the device for
device-id required	string The ID of the device to delete

Responses

Health

The health-check module

Get health status

Responses

Response samples

200
500

Content type

application/json

{"status": "UP",
"checks": [{"name": "string",
"status": "UP",
"data": { }
}
],
"service": {"name": "string",
"version": "string",
"buildDate": "string",
"date": "string",
"timeZone": "string",
"locale": "string",
"charset": "string"
},
"blacklist": ["string"
],
"ignorelist": ["string"
]
}

name required	string The user's login name
contextId required	integer <int64> The context id

name required	string The user's login name
contextId required	integer <int64> The context id

reseller required	string The reseller name
package required	string The package name

reseller required	string The reseller name
package required	string The package name

contextId required	integer <int64> The context id
userId required	integer <int64> The user id

OX REST API (7.10.3)

Authentication

basicAuth

contextAdminAuth

masterAdminAuth

Userfeedback

Exports user feedback

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Exports user feedback as CSV

Authorizations:

path Parameters

query Parameters

Responses

Deletes user feedback

path Parameters

query Parameters

Responses

Response samples

Exports user feedback and sends exported data to provided recipients

path Parameters

query Parameters

Request Body schema: application/json

Responses

Request samples

Advertisement

Sets an advertisement configuration for a given user by name

query Parameters

Request Body schema: application/json

Responses

Request samples

Remove the current configuration for the user

query Parameters

Responses

Sets an advertisement configuration for a package of a reseller

query Parameters

Request Body schema: application/json

Responses

Request samples

Remove the current configuration for a package of a reseller

query Parameters

Responses

Sets all advertisement configurations for a given reseller

query Parameters

Request Body schema: application/json

Responses

Request samples

Sets an advertisement configuration for a given user by id

query Parameters

Request Body schema: application/json

Responses

Request samples

Remove the current configuration for the user identified by userId

query Parameters

Responses

Admin

Close all sessions belonging to a context

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Close a session by its ID

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Request samples

Close all sessions belonging to a user

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Request samples

Lists all multifactor authentication devices for a user.

Authorizations: