...
Description: Ensures a user with the specified username exists.
Parameters
| Name | Description | Default value |
username(required) | The username for which a user profile should be created if it doesn't exist already. | - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/users/alice |
...
Description: Deletes the user profile with the specified username if it exists.
Parameters
| Name | Description | Default value |
username(required) | The username for which a user profile should be deleted if it exists. | - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/users/alice |
Example response body: none (status code 204 indicates success/, 404 indicates user not found)
/users/{username}/synchronizations
...
Description: Query all synchronizations for a user.
Parameters:
| Name | Description | Default value |
username(required) | The username for which the synchronization should be created. | - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/users/alice/synchronizations |
...
Description: Delete all synchronizations for a user.
Parameters:
| Name | Description | Default value |
username(required) | The username for which the synchronizations should be deleted. | - |
unlinkMode(required) | The unlink mode indicates what should happen to the events in the user's calendar:
| - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/users/alice/synchronizations?unlinkMode=DELETE_ALL_EVENTS |
...
Description: Delete synchronizations of a certain type for a certain user.
Parameters:
| Name | Description | Default value |
username(required) | The username for which the synchronizations should be deleted. | - |
type(required) | The synchronization type, which indicates the calendaring service provider. | - |
unlinkMode(required) | The unlink mode indicates what should happen to the events in the user's calendar:
| - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/users/alice/synchronizations/ews?unlinkMode=DELETE_ALL_EVENTS |
Example response body: none (status code 204 indicates success; 422 404 indicates no synchronizations found; 422 indicates invalid synchronisation type)
Synchronization resources
...
Description: Sets up a synchronization with a user's external calendar.
Parameters
| Name | Description | Default value |
username(required) | The username for which the synchronization should be created. | - |
type(required) | The synchronization type, which indicates the calendaring service provider. | - |
| provisioning_smtpAddress * | The user's mailbox address in Exchange or Office 365. | - |
* Only applicable when using a ProvisioningPreDelegatedEWSLinkingAdapter or ProvisioningPreAuthorizedOffice365LinkingAdapter.
...
Description: Deletes the synchronization with the specified id.
Parameters
| Name | Description | Default value |
id(required) | The id of the synchronization which should be deleted. | - |
unlinkMode(required) | The unlink mode indicates what should happen to the events in the user's calendar:
| - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/synchronizations/3?unlinkMode=UNLINK_ONLY |
Example response body: none (status code 204 indicates success; 422 404 indicates synchronization not found)
...