keyboard_arrow_down
  • 12.0
  • 20.0

Administrators

Describe an Administrator

get/administrators/{administratorID}

Describe an administrator by ID.

Related SDK Methods:
Java

AdministratorsApi.describeAdministrator([param1, param2, ...])
Python

AdministratorsApi.describe_administrator([param1, param2, ...])
JavaScript

AdministratorsApi.describeAdministrator([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
administratorID
required
integer <int32> \d+

The ID number of the administrator to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view administrators.

404

The administrator does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
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 DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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();
		}
	}
}
Response samples
application/json
{
  • "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

post/administrators/{administratorID}

Modify an administrator by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

AdministratorsApi.modifyAdministrator([param1, param2, ...])
Python

AdministratorsApi.modify_administrator([param1, param2, ...])
JavaScript

AdministratorsApi.modifyAdministrator([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
administratorID
required
integer <int32> \d+

The ID number of the administrator to modify.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the administrator to modify.

active
boolean

If set to true, the Administrator can authenticate. If set to false, the Administrator is locked out. Searchable as Boolean.

description
string

Description of the Administrator. Searchable as String.

emailAddress
string

Email address of the Administrator. Searchable as String.

fullName
string

Full name of the Administrator. Searchable as String.

locale
string

Locale of the Administrator.

Enum: "en-US" "ja-JP"
mfaType
string

Specifies the type of multi-factor authentication used to authenticate the Administrator. Defaults to none. Searchable as Choice.

Enum: "none" "local-totp"
mobileNumber
string

Mobile number of the Administrator. Searchable as String.

pagerNumber
string

Pager number of the Administrator. Searchable as String.

password
string

Password of the Administrator.

passwordNeverExpires
boolean

Enabled if the Administrator's password never expires. Defaults to false. Searchable as Boolean.

phoneNumber
string

Phone number of the Administrator. Searchable as String.

primaryContact
boolean

If set to true, the administrator is a primary contact. Primary contacts receive Deep Security as a Service account-related emails for that tenant. A valid emailAddress is required. Searchable as Boolean.

receiveNotifications
boolean

If set to true, alert emails will be sent to the Administrator. A valid emailAddress is required. Searchable as Boolean.

reportPDFPassword
string

Password that protects the reports that the Administrator generates. Ignored when reportPDFPasswordEnabled is false.

reportPDFPasswordEnabled
boolean

Controls whether the reports that the Administrator generates are password-protected. Set to true to password-protect, and false otherwise. Defaults to false. Searchable as Boolean.

roleID
integer <int32>

ID of the role assigned to the Administrator. Searchable as Numeric.

timeFormat
string

Time format preference of the Administrator. Can be either the 12-hour format or the 24-hour format. Searchable as Choice.

Enum: "12" "24"
timeZone
string

Time zone of the Administrator. Searchable as String.

username
string

Username of the Administrator. Searchable as String.

UTCOffset
string

UTC offset of the Administrator.

Responses
200

successful operation

403

Not authorized to modify administrators or the requested modification is not permitted.

404

The administrator does not exist.

Request samples
application/json
{
  • "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"
}
Response samples
application/json
{
  • "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/administrators/{administratorID}

Delete an administrator by ID.

Related SDK Methods:
Java

AdministratorsApi.deleteAdministrator([param1, param2, ...])
Python

AdministratorsApi.delete_administrator([param1, param2, ...])
JavaScript

AdministratorsApi.deleteAdministrator([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
administratorID
required
integer <int32> \d+

The ID number of the administrator to delete.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

Request is successful.

403

Not authorized to delete administrators.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
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 DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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();
		}
	}
}

List Administrators

get/administrators

Lists all administrators.

Related SDK Methods:
Java

AdministratorsApi.listAdministrators([param1, param2, ...])
Python

AdministratorsApi.list_administrators([param1, param2, ...])
JavaScript

AdministratorsApi.listAdministrators([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view administrators.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
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 DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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();
		}
	}
}
Response samples
application/json
{
  • "administrators": [
    ]
}

Create an Administrator

post/administrators

Create a new administrator.

Related SDK Methods:
Java

AdministratorsApi.createAdministrator([param1, param2, ...])
Python

AdministratorsApi.create_administrator([param1, param2, ...])
JavaScript

AdministratorsApi.createAdministrator([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the new administrator.

active
boolean

If set to true, the Administrator can authenticate. If set to false, the Administrator is locked out. Searchable as Boolean.

description
string

Description of the Administrator. Searchable as String.

emailAddress
string

Email address of the Administrator. Searchable as String.

fullName
string

Full name of the Administrator. Searchable as String.

locale
string

Locale of the Administrator.

Enum: "en-US" "ja-JP"
mfaType
string

Specifies the type of multi-factor authentication used to authenticate the Administrator. Defaults to none. Searchable as Choice.

Enum: "none" "local-totp"
mobileNumber
string

Mobile number of the Administrator. Searchable as String.

pagerNumber
string

Pager number of the Administrator. Searchable as String.

password
string

Password of the Administrator.

passwordNeverExpires
boolean

Enabled if the Administrator's password never expires. Defaults to false. Searchable as Boolean.

phoneNumber
string

Phone number of the Administrator. Searchable as String.

primaryContact
boolean

If set to true, the administrator is a primary contact. Primary contacts receive Deep Security as a Service account-related emails for that tenant. A valid emailAddress is required. Searchable as Boolean.

receiveNotifications
boolean

If set to true, alert emails will be sent to the Administrator. A valid emailAddress is required. Searchable as Boolean.

reportPDFPassword
string

Password that protects the reports that the Administrator generates. Ignored when reportPDFPasswordEnabled is false.

reportPDFPasswordEnabled
boolean

Controls whether the reports that the Administrator generates are password-protected. Set to true to password-protect, and false otherwise. Defaults to false. Searchable as Boolean.

roleID
integer <int32>

ID of the role assigned to the Administrator. Searchable as Numeric.

timeFormat
string

Time format preference of the Administrator. Can be either the 12-hour format or the 24-hour format. Searchable as Choice.

Enum: "12" "24"
timeZone
string

Time zone of the Administrator. Searchable as String.

username
string

Username of the Administrator. Searchable as String.

UTCOffset
string

UTC offset of the Administrator.

Responses
200

successful operation

403

Not authorized to create administrators.

Request samples
application/json
{
  • "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"
}
Response samples
application/json
{
  • "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"
}

Search Administrators

post/administrators/search

Search for administrators using optional filters.

Related SDK Methods:
Java

AdministratorsApi.searchAdministrators([param1, param2, ...])
Python

AdministratorsApi.search_administrators([param1, param2, ...])
JavaScript

AdministratorsApi.searchAdministrators([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view administrators.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "administrators": [
    ]
}
➔ Next to Administrator Roles