# Continuity-Service

REST service to maintain Retarus Email Continuity mailboxes and control failover routing


## Servers

Public Endpoint
```
https://api.retarus.com/email/continuity/v2/
```

## Security

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[Continuity-Service](https://developers.retarus.com/_bundle/seg/email-continuity-api.yaml)

## Customer

Bulk request, update or delete user information for all users belonging to the {CUSTOMER} number specified in the path of a request

### Request user count information for all users belonging to the {CUSTOMER} specified in the URL path

 - [HEAD /{CUSTOMER}](https://developers.retarus.com/seg/email-continuity-api/customer/paths/~1%7Bcustomer%7D/head.md)

### Request user information for all users belonging to the {CUSTOMER} specified in the URL path

 - [GET /{CUSTOMER}](https://developers.retarus.com/seg/email-continuity-api/customer/paths/~1%7Bcustomer%7D/get.md)

### Create several users belonging to the {CUSTOMER} specified in the URL path

 - [PUT /{CUSTOMER}](https://developers.retarus.com/seg/email-continuity-api/customer/paths/~1%7Bcustomer%7D/put.md)

### Update existing users belonging to the {CUSTOMER} specified in the URL path

 - [PATCH /{CUSTOMER}](https://developers.retarus.com/seg/email-continuity-api/customer/paths/~1%7Bcustomer%7D/patch.md)

### Delete existing users

 - [DELETE /{CUSTOMER}](https://developers.retarus.com/seg/email-continuity-api/customer/paths/~1%7Bcustomer%7D/delete.md)

## Customer Flag

Update or delete flag for all users belonging to the {CUSTOMER} number specified in the path of a request, e.g. activate the Email Continuity failover or access to the web mailbox for all users

### Set flag for all users belonging to the {CUSTOMER} specified in the URL path

 - [PUT /{CUSTOMER}/{FLAG}](https://developers.retarus.com/seg/email-continuity-api/customer-flag/paths/~1%7Bcustomer%7D~1%7Bflag%7D/put.md)

### Remove flag for all users belonging to the {CUSTOMER} specified in the URL path

 - [DELETE /{CUSTOMER}/{FLAG}](https://developers.retarus.com/seg/email-continuity-api/customer-flag/paths/~1%7Bcustomer%7D~1%7Bflag%7D/delete.md)

## User

Request, update or delete user information for a single user belonging to the {CUSTOMER} number specified in the path of a request

### Request user information

 - [GET /{CUSTOMER}/{USER}](https://developers.retarus.com/seg/email-continuity-api/user/paths/~1%7Bcustomer%7D~1%7Buser%7D/get.md)

### Create new user

 - [PUT /{CUSTOMER}/{USER}](https://developers.retarus.com/seg/email-continuity-api/user/paths/~1%7Bcustomer%7D~1%7Buser%7D/put.md)

### Update existing user

 - [PATCH /{CUSTOMER}/{USER}](https://developers.retarus.com/seg/email-continuity-api/user/paths/~1%7Bcustomer%7D~1%7Buser%7D/patch.md)

### Delete existing user

 - [DELETE /{CUSTOMER}/{USER}](https://developers.retarus.com/seg/email-continuity-api/user/paths/~1%7Bcustomer%7D~1%7Buser%7D/delete.md)

## User Flag

Update or delete flag for a single user belonging to the {CUSTOMER} number specified in the path of a request, e.g. activate the Email Continuity failover or the access to the web mailbox

### Set flag for a single user

 - [PUT /{CUSTOMER}/{USER}/{FLAG}](https://developers.retarus.com/seg/email-continuity-api/user-flag/paths/~1%7Bcustomer%7D~1%7Buser%7D~1%7Bflag%7D/put.md)

### Remove flag for a single user

 - [DELETE /{CUSTOMER}/{USER}/{FLAG}](https://developers.retarus.com/seg/email-continuity-api/user-flag/paths/~1%7Bcustomer%7D~1%7Buser%7D~1%7Bflag%7D/delete.md)

## Token

Request a security token required for account activation and password reset

### Create new password token for account activation or password reset. The response contains an URL directing the user to a web frontend where the user can set or reset the password. The URL consists of base part and token. The base part is subject to static configuration and may contain an individual path component for each customer

 - [POST /{CUSTOMER}/{USER}/token](https://developers.retarus.com/seg/email-continuity-api/token/paths/~1%7Bcustomer%7D~1%7Buser%7D~1token/post.md)

## Password

Update user password using a security token

### Set user password (requires no authentication)

 - [PUT /{USER}/password](https://developers.retarus.com/seg/email-continuity-api/password/paths/~1%7Buser%7D~1password/put.md)