com.trendmicro.ds.platform.rest.api

Interface ITenantTemplateAPI

public interface ITenantTemplateAPI

Interface for the Tenant Template API.

Method Summary

Modifier and Type	Method and Description
CreateTenantTemplateResponse	createTenantTemplate(CreateTenantTemplateRequest createTenantTemplateRequest) Create a new tenant template using the provided tenantId.
TenantTemplateElement	getTenantTemplate(java.lang.String sID) Retrieve the current tenant template.

Method Detail

getTenantTemplate

TenantTemplateElement getTenantTemplate(java.lang.String sID)
                                 throws java.lang.Exception

Retrieve the current tenant template. The template is used when creating new tenants, with the new tenant getting the rules and policies set in the template.

Parameters:

sID - session id.

Returns:

The information about the tenant template (if any).

Throws:

java.lang.Exception

createTenantTemplate

CreateTenantTemplateResponse createTenantTemplate(CreateTenantTemplateRequest createTenantTemplateRequest)
                                           throws java.lang.Exception

Create a new tenant template using the provided tenantId. This new template replaces the existing template.

Parameters:

createTenantTemplateRequest - the request parameters.

Returns:

A response with code 200 OK and a body containing a CreateTenantTemplateResponse when the template creation was successful. It will return code 400 Bad Request and a body containing an ErrorMessage when mandatory parameters are missing and/or validation fails.

Throws:

java.lang.Exception