Search Administrators
Search for administrators using optional filters.
AdministratorsApi.searchAdministrators([param1, param2, ...])
AdministratorsApi.search_administrators([param1, param2, ...])
AdministratorsApi.searchAdministrators([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
Not authorized to view administrators.
- Payload
- Java
- Python
- JavaScript
{- "maxItems": 0,
- "searchCriteria": [
- {
- "fieldName": "string",
- "booleanTest": true,
- "numericTest": "less-than",
- "numericValue": 0,
- "numericValueList": [
- 0
], - "stringTest": "equal",
- "stringValue": "string",
- "stringWildcards": true,
- "choiceTest": "equal",
- "choiceValue": "string",
- "firstDateValue": 0,
- "firstDateInclusive": true,
- "lastDateValue": 0,
- "lastDateInclusive": true,
- "nullTest": true,
- "versionTest": "less-than",
- "versionValue": "string",
- "idValue": 0,
- "idTest": "less-than",
- "idValueList": [
- 0
]
}
], - "sortByObjectID": true
}
- 200
{- "administrators": [
- {
- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "created": 0,
- "lastPasswordChange": 0,
- "lastSignIn": 0,
- "unlockTime": 0,
- "unsuccessfulSignInAttempts": 0,
- "directoryName": "string",
- "directoryInfo": "string",
- "external": true,
- "externalUserID": "string",
- "type": "normal",
- "readOnly": true,
- "ID": 0,
- "UTCOffset": "string"
}
]
}
List Administrators
Lists all administrators.
AdministratorsApi.listAdministrators([param1, param2, ...])
AdministratorsApi.list_administrators([param1, param2, ...])
AdministratorsApi.listAdministrators([param1, param2, ...])
successful operation
Not authorized to view administrators.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AdministratorsApi; import com.trendmicro.deepsecurity.model.Administrators; public class ListAdministratorsExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AdministratorsApi instance = new AdministratorsApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Administrators result = instance.listAdministrators(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling AdministratorsApi.listAdministrators"); e.printStackTrace(); } } }
- 200
{- "administrators": [
- {
- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "created": 0,
- "lastPasswordChange": 0,
- "lastSignIn": 0,
- "unlockTime": 0,
- "unsuccessfulSignInAttempts": 0,
- "directoryName": "string",
- "directoryInfo": "string",
- "external": true,
- "externalUserID": "string",
- "type": "normal",
- "readOnly": true,
- "ID": 0,
- "UTCOffset": "string"
}
]
}
Create an Administrator
Create a new administrator. Not authorized for Trend Micro Cloud One users.
AdministratorsApi.createAdministrator([param1, param2, ...])
AdministratorsApi.create_administrator([param1, param2, ...])
AdministratorsApi.createAdministrator([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new administrator.
successful operation
Not authorized to create administrators.
- Payload
- Java
- Python
- JavaScript
{- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "UTCOffset": "string"
}
- 200
{- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "created": 0,
- "lastPasswordChange": 0,
- "lastSignIn": 0,
- "unlockTime": 0,
- "unsuccessfulSignInAttempts": 0,
- "directoryName": "string",
- "directoryInfo": "string",
- "external": true,
- "externalUserID": "string",
- "type": "normal",
- "readOnly": true,
- "ID": 0,
- "UTCOffset": "string"
}
Delete an Administrator
Delete an administrator by Username. Not authorized for Trend Micro Cloud One users.
AdministratorsApi.deleteAdministratorFromUsername([param1, param2, ...])
AdministratorsApi.delete_administrator_from_username([param1, param2, ...])
AdministratorsApi.deleteAdministratorFromUsername([param1, param2, ...])
Request is successful.
Not authorized to delete administrators.
The administrator does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AdministratorsApi; public class DeleteAdministratorFromUsernameExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AdministratorsApi instance = new AdministratorsApi(); String administratorUsername = "administratorUsername_example"; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteAdministratorFromUsername(administratorUsername, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling AdministratorsApi.deleteAdministratorFromUsername"); e.printStackTrace(); } } }
Delete an Administrator by T0
Delete an administrator by T0. Not authorized for Trend Micro Cloud One users.
AdministratorsApi.deleteAdministratorFromUsernameByT0([param1, param2, ...])
AdministratorsApi.delete_administrator_from_username_by_t0([param1, param2, ...])
AdministratorsApi.deleteAdministratorFromUsernameByT0([param1, param2, ...])
Request is successful.
Not authorized to delete administrators.
The administrator does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AdministratorsApi; public class DeleteAdministratorFromUsernameByT0Example { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AdministratorsApi instance = new AdministratorsApi(); String administratorUsername = "administratorUsername_example"; String customerAccountId = "customerAccountId_example"; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteAdministratorFromUsernameByT0(administratorUsername, customerAccountId, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling AdministratorsApi.deleteAdministratorFromUsernameByT0"); e.printStackTrace(); } } }
Describe an Administrator
Describe an administrator by ID.
AdministratorsApi.describeAdministrator([param1, param2, ...])
AdministratorsApi.describe_administrator([param1, param2, ...])
AdministratorsApi.describeAdministrator([param1, param2, ...])
successful operation
Not authorized to view administrators.
The administrator does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AdministratorsApi; import com.trendmicro.deepsecurity.model.Administrator; public class DescribeAdministratorExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AdministratorsApi instance = new AdministratorsApi(); Integer administratorID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Administrator result = instance.describeAdministrator(administratorID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling AdministratorsApi.describeAdministrator"); e.printStackTrace(); } } }
- 200
{- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "created": 0,
- "lastPasswordChange": 0,
- "lastSignIn": 0,
- "unlockTime": 0,
- "unsuccessfulSignInAttempts": 0,
- "directoryName": "string",
- "directoryInfo": "string",
- "external": true,
- "externalUserID": "string",
- "type": "normal",
- "readOnly": true,
- "ID": 0,
- "UTCOffset": "string"
}
Modify an Administrator
Modify an administrator by ID. Any unset elements will be left unchanged.
AdministratorsApi.modifyAdministrator([param1, param2, ...])
AdministratorsApi.modify_administrator([param1, param2, ...])
AdministratorsApi.modifyAdministrator([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the administrator to modify.
successful operation
Not authorized to modify administrators or the requested modification is not permitted.
The administrator does not exist.
- Payload
- Java
- Python
- JavaScript
{- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "UTCOffset": "string"
}
- 200
{- "username": "string",
- "password": "string",
- "fullName": "string",
- "description": "string",
- "roleID": 0,
- "locale": "en-US",
- "timeZone": "string",
- "timeFormat": "12",
- "passwordNeverExpires": true,
- "active": true,
- "mfaType": "none",
- "phoneNumber": "string",
- "mobileNumber": "string",
- "pagerNumber": "string",
- "emailAddress": "string",
- "primaryContact": true,
- "receiveNotifications": true,
- "reportPDFPasswordEnabled": true,
- "reportPDFPassword": "string",
- "created": 0,
- "lastPasswordChange": 0,
- "lastSignIn": 0,
- "unlockTime": 0,
- "unsuccessfulSignInAttempts": 0,
- "directoryName": "string",
- "directoryInfo": "string",
- "external": true,
- "externalUserID": "string",
- "type": "normal",
- "readOnly": true,
- "ID": 0,
- "UTCOffset": "string"
}
Delete an Administrator
Delete an administrator by ID. Not authorized for Trend Micro Cloud One users.
AdministratorsApi.deleteAdministrator([param1, param2, ...])
AdministratorsApi.delete_administrator([param1, param2, ...])
AdministratorsApi.deleteAdministrator([param1, param2, ...])
Request is successful.
Not authorized to delete administrators.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AdministratorsApi; public class DeleteAdministratorExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AdministratorsApi instance = new AdministratorsApi(); Integer administratorID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteAdministrator(administratorID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling AdministratorsApi.deleteAdministrator"); e.printStackTrace(); } } }