Clients
This section provides information on the available client APIs.
The following are the available client endpoints:
|
Endpoint |
Description |
Request |
|---|---|---|
|
POST |
Add a new client in a domain and workgroup. |
POST /crs/api/v1/clients |
|
GET |
Retrieve client information using the client ID provided in the request. |
GET /crs/api/v1/clients/{clientId} |
|
PUT |
Update the client information using the client ID provided in the request using the PUT method. |
PUT /crs/api/v1/clients/{clientId} |
|
PATCH |
Update the client information using the client ID provided in the request using the PATCH method. |
PATCH /crs/api/v1/clients/{clientId} |
|
POST |
Add a new address for a client using the client ID provided in the request. |
POST /crs/api/v1/clients/{clientId}/addresses |
|
PUT |
Update an address for the client using the client and address ID provided in the request. |
PUT /crs/api/v1/clients/{clientId}/addresses/{addressId} |
|
DELETE |
Remove an address from a client using the client and address ID provided in the request. |
DELETE /crs/api/v1/clients/{clientId}/addresses/{addressId} |
|
POST |
Add a new recipient for a client using the client ID provided in the request. |
POST /crs/api/v1/clients/{clientId}/recipients |
|
GET |
Retrieve recipient information using the client ID provided in the request. |
GET /crs/api/v1/clients/{clientId}/recipients/{recipientId} |
|
PUT |
Update a recipient using the client ID provided in the request. |
PUT /crs/api/v1/clients/{clientId}/recipients/{recipientId} |
|
GET |
Retrieve client information using parameters specified in the request. |
GET /crs/api/v1/clients/search |
|
DELETE |
Remove a recipient from a client using the client and recipient ID provided in the request. |
DELETE /crs/api/v1/clients/{clientId}/recipient/{recipientId} |
