Help Manual

Azure Active Directory Connectivity

Documentation for Azure Active Directory drivers found within JDBC Driver Pack

Azure Active Directory

Building the JDBC URL

After installing the license, access the connection management page by executing the command java -jar kingswaysoft.jdbc.jar. Enter the necessary details, and the program will automatically generate the JDBC connection URL. Users can click Test Connection to test the generated URL, and Copy to Clipboard to copy the connection string for use within the application where the JDBC driver is being used.

Note: If the license is not installed, you can still use the connection manager to generate a JDBC URL; however, the 'Test Connection' feature will be disabled.

General Page

The General page of the Active Directory Connection Manager allows you to specify the general settings of the connection:

connectionmanage

Authentication
Authentication Mode

The Authentication Mode option allows you to choose the method used to authenticate with the Azure Active Directory API. Available options are:

  • Authorization Code
  • Certificate
  • Client Credentials

Authentication Methods for Azure Active Directory

Authorization Code

A saved token file and token password can be used to establish a connection. If you wish to generate a new token file, click Generate Token File to go through the token generation process, save the token file locally, and use the set token password to connect.

Authentication
Path To Token File

The path to the token file on the file system.

Token File Password

The password to the token file.

Generate Token File

This button completes the OAuth authentication process in order to generate a new token.

  • Tenant ID: The Tenant ID option allows you to specify the unique ID which identifies the application making the request.
  • Client ID: The Client ID option allows you to specify the unique ID which identifies the user making the request.
  • Client Secret: The Client Secret option allows you to specify the client secret belonging to your app.
  • Redirect URL: The Redirect URL option allows you to specify the Redirect URL to complete the authentication process.
  • Scope: A space-separated set of scopes that your app will need access to. Click the ellipsis button to launch a tree view of available scopes from which you can select the scopes that you need for the connection. It is important to note that you should only select those scopes that are required for your integration jobs. However, it is not uncommon to select all if desired.
  • PKCE (Enhanced Security): The PKCE (Proof Key for Code Exchange) option may be enabled for PKCE App Type. Ensures that the client that initiates the OAuth flow is the same client that completes flow.
Certificate

A saved certificate file and certificate password can be used to establish a connection. Set the path to the certificate file, as well as the certificate password, the tenant ID and the client ID to authenticate and connect.

NOTE: The certificate file only supports the PFX format. For newly generated certificates, a PEM file is also generated. This PEM file needs to be configured in the portal.

Authentication
Tenant Id

Specify the Tenant Id to be used when establishing the connection to the Azure Active Directory API.

Client Id

Specify the Client Id to be used when establishing the connection to the Azure Active Directory API.

Path To Certificate

The path to an existing certificate file.

Certificate Password

The password for the specified certificate file.

Client Credentials

Users can choose to use their Tenant ID, Client ID and Client Secret to establish a connection.

Authentication
Tenant Id

Specify the Tenant Id to be used when establishing the connection to the Azure Active Directory API.

Client Id

Specify the Client Id to be used when establishing the connection to the Azure Active Directory API.

Client Secret

The Client Secret option allows you to specify the client secret that will be used when establishing a connection to the Azure Active Directory API.

Advanced Settings Page

The Advanced Settings page allows you to specify advanced settings for the connection.

connectionmanage

Proxy Server Settings
Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Use system configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Miscellaneous Settings
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds. Specify 0 for infinite timeout.

API Throttling Rate

The API Throttling Rate will limit the number of requests that can be sent per the unit of time selected. Set this value to 0 to disable API throttling.

Retry on Intermittent Errors

The retry on intermittent errors determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to the target server.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Note: When this option is enabled, it applies to all HTTP-based SSL connections in the same job process.

Concurrent Writing Threads

This option can be used to set the number of threads to be used during write operations. This can improve performance during large-volume write operations.

Using the JDBC Driver

Explore detailed examples in this section that demonstrate the application of JDBC classes such as Connection, Statement, and ResultSet to effectively manage interactions with Active Directory data. This section covers the use of regular statements and prepared statements for executing complex or frequently executed queries.

Executing Statements

Once you've connected from your code (see Connecting with DriverManager and Connecting with DataSource), you can execute SQL statements using the Statement class. Refer to the Executing Prepared Statements section for information on how to execute parameterized statements.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data. To retrieve the results of a query, you would then call the getResultSet method of the Statement.

String sql = "SELECT * FROM User WHERE id = '12718fb4-a96c-4b39-a9d4-300698b5e11b'";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the inserted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "INSERT INTO User (accountEnabled, displayName, mailNickname, passwordProfile.forceChangePasswordNextSignIn, passwordProfile.forceChangePasswordNextSignInWithMfa, passwordProfile.password, userPrincipalName) VALUES (true, 'name', 'nickname', true, true, 'Password123!', '[email protected]')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
a0f992bc-0c04-404c-86a2-3d652becce71,null,null,{"accountEnabled":true,"displayName":"name","mailNickname":"nickname","passwordProfile":{"forceChangePasswordNextSignIn":true,"forceChangePasswordNextSignInWithMfa":true,"password":"****"},"userPrincipalName":"[email protected]"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the updated data's ID, exceptions raised during execution, and details of the affected data.

String sql = "UPDATE User SET givenName = 'update' WHERE id = 'a0f992bc-0c04-404c-86a2-3d652becce71'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
a0f992bc-0c04-404c-86a2-3d652becce71,null,null,{"givenName":"update"},false
String sql = "UPDATE User SET city = 'Toronto' WHERE mailNickname = 'green'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
d624057d-8bdd-4bed-a6c4-bbeb217fb615,null,null,{"city":"Toronto"},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM User WHERE id = 'a0f992bc-0c04-404c-86a2-3d652becce71'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
a0f992bc-0c04-404c-86a2-3d652becce71,null,null,null,false
String sql = "DELETE FROM User WHERE mailNickname = 'green'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
d624057d-8bdd-4bed-a6c4-bbeb217fb615,null,null,{},false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String sql = "UPSERT INTO Group (displayName, mailEnabled, mailNickname, securityEnabled, uniqueName) VALUES ('name', false, 'nickname', true, 'uniqueName') ON DUPLICATE KEY UPDATE UPSERTFIELDS = (uniqueName)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors,isnew
77f42d7f-6fb3-4416-acd8-54cc54e87cf8,null,null,{"displayName":"name","mailEnabled":false,"mailNickname":"nickname","securityEnabled":true},false,true
String sql = "UPSERT INTO User (mailNickname, country, passwordProfile.password, accountEnabled, displayName, userPrincipalName) VALUES ('testMailNickName', 'testCountry', 'testPassword@123.', true, 'testDN', '[email protected]') ON DUPLICATE key update UPSERTFIELDS=(mailNickname)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors,isnew
fab7fab3-443b-4f85-ab73-97941b8e5d0e,null,null,{"mailNickname":"testMailNickName","country":"testCountry","passwordProfile":{"password":"testPassword@123."},"accountEnabled":true,"displayName":"testDN","userPrincipalName":"[email protected]"},false,true

Executing Prepared Statements

Using a PreparedStatement can improve performance when you need to execute a SQL statement multiple times with different parameters. Unlike a Statement object, a PreparedStatement object is provided with a SQL statement when it is created, which can then be executed with different values each time. This special type of statement is derived from the more general class, Statement.

Below are the steps outlining how to execute a prepared statement:

  1. Create a PreparedStatement: Use the prepareStatement method of the Connection class to instantiate a PreparedStatement. Refer to Connecting with DriverManager or Connecting with DataSource for information related to establishing connections.
  2. Set Parameters: Declare parameters by calling the corresponding setter method of the PreparedStatement. Note: The parameter indices start at 1.
  3. Execute the Statement: Use the generic execute or executeUpdate method of the PreparedStatement.
  4. Retrieve Results: Call the getResultSet method of the Prepared Statement to obtain the query results, which will be returned as a ResultSet.
  5. Iterate Over the Result Set: Use the next method of the ResultSet to iterate through the results. To obtain column information, utilize the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the retrieved data.

String sql = "SELECT * FROM User WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "12718fb4-a96c-4b39-a9d4-300698b5e11b");
    ps.execute(query);
    while (ps.getResultSet().next()) {
        for (int i = 1; i <= ps.getResultSet().getMetaData().getColumnCount(); i++) {
            LOGGER.info(ps.getResultSet().getMetaData().getColumnLabel(i) + "="
            + ps.getResultSet().getString(i));
        }
    }
} catch (SQLException e) {
    LOGGER.error(e);
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String sql = "INSERT INTO User (accountEnabled, displayName, mailNickname, passwordProfile.forceChangePasswordNextSignIn, passwordProfile.forceChangePasswordNextSignInWithMfa, passwordProfile.password, userPrincipalName) VALUES (?, ?, ?, ?, ?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setBoolean(1, true);
    ps.setString(2, "name");
    ps.setString(3, "nickname");
    ps.setBoolean(4, true);
    ps.setBoolean(5, true);
    ps.setString(6, "Password123!");
    ps.setString(7, "[email protected]");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
a0f992bc-0c04-404c-86a2-3d652becce71,null,null,{"accountEnabled":true,"displayName":"name","mailNickname":"nickname","passwordProfile":{"forceChangePasswordNextSignIn":true,"forceChangePasswordNextSignInWithMfa":true,"password":"****"},"userPrincipalName":"[email protected]"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of updated data, exceptions raised during execution, and the data affected by the update.

String sql = "UPDATE User SET givenName = ? WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "update");
    ps.setString(2, "a0f992bc-0c04-404c-86a2-3d652becce71");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
a0f992bc-0c04-404c-86a2-3d652becce71,null,null,{"givenName":"update"},false
String sql = "UPDATE User SET city = ? WHERE mailNickname = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "Toronto");
    ps.setString(2, "greenNick");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
b53d70c6-b942-4419-8aac-c2e42c0b5112,null,null,{"city":"Toronto"},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM User WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "a0f992bc-0c04-404c-86a2-3d652becce71");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
a0f992bc-0c04-404c-86a2-3d652becce71,null,null,null,false
String sql = "DELETE FROM User WHERE mailNickname = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "greenNick");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
b53d70c6-b942-4419-8aac-c2e42c0b5112,null,null,{},false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String sql = "UPSERT INTO Group (displayName, mailEnabled, mailNickname, securityEnabled, uniqueName) VALUES ('name', false, 'nickname', true, 'uniqueName') ON DUPLICATE KEY UPDATE UPSERTFIELDS = (uniqueName)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "name");
    ps.setBoolean(2, false);
    ps.setString(3, "nickname");
    ps.setBoolean(4, true);
    ps.setString(5, "uniqueName");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors,isnew
77f42d7f-6fb3-4416-acd8-54cc54e87cf8,null,null,{"displayName":"name","mailEnabled":false,"mailNickname":"nickname","securityEnabled":true},false,true
String sql = "UPSERT INTO User (mailNickname, country, passwordProfile.password, accountEnabled, displayName, userPrincipalName) VALUES (?, ?, ?, ?, ?, ?) ON DUPLICATE key update UPSERTFIELDS=(mailNickname)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "testMailNickName");
    ps.setString(2, "testCountry");
    ps.setString(3, "testPassword@123.");
    ps.setBoolean(4, true);
    ps.setString(5, "testDN");
    ps.setString(6, "[email protected]");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors,isnew
fab7fab3-443b-4f85-ab73-97941b8e5d0e,null,null,{"mailNickname":"testMailNickName","country":"testCountry","passwordProfile":{"password":"testPassword@123."},"accountEnabled":true,"displayName":"testDN","userPrincipalName":"[email protected]"},false,true

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables and getColumns methods from the DatabaseMetaData interface. These are essential for discovering database structures.

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

This method only retrieves tables that are not write-only.

To get a list of tables which include write-only tables, query the table [system.tables](/products/jdbc-driver-pack/help-manual/advancedfeatures#systemtables).

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
    LOGGER.info("\r\n" + rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,Device,Table,nullnull,null,ExtensionProperties,Table,nullnull,null,Group,Table,nullnull,null,Group/Members,Table,nullnull,null,SchemaExtensions,Table,nullnull,null,User,Table,nullnull,null,User/Photo,Table,nullnull,null,system.columns,Table,nullnull,null,system.tables,Table,null

The getTables method returns the following metadata columns:

Column Name Data Type Description
TABLE_CAT String The catalog that contains the table.
TABLE_SCHEM String The schema of the table.
TABLE_NAME String The name of the table.
TABLE_TYPE String The type of the table (e.g., TABLE or VIEW).
REMARKS String An optional description of the table.

Columns

Use the getColumns method of the DatabaseMetaData interface to retrieve detailed information about database columns. To narrow the results to a specific table, specify the table name using the parameter table_name.

This method returns columns only for tables that are not write-only.

To get columns for tables which are write-only, query the table [system.columns](/products/jdbc-driver-pack/help-manual/advancedfeatures#systemcolumns).

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "User", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    e.printStackTrace();
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,REMARKS,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,User,aboutMe,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,accountEnabled,16,BOOLEAN,null,null,0,0,null,null,null,16,null,null,null,null,null,null,DT_BOOL
null,null,User,ageGroup,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,assignedLicenses,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,assignedPlans,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,birthday,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,User,businessPhones,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,city,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,companyName,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,User,consentProvidedForMinor,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
......

The getColumns method returns the following columns:

Column Name Data Type Description
TABLE_CAT String The database name.
TABLE_SCHEM String The table schema.
TABLE_NAME String The table name.
COLUMN_NAME String The column name.
DATA_TYPE Integer The data type represented by a constant value from java.sql.Types.
TYPE_NAME String The data type name used by the driver.
COLUMN_SIZE Integer The length in characters of the column or the numeric precision.
BUFFER_LENGTH Integer The buffer length.
DECIMAL_DIGITS Integer The column scale or number of digits to the right of the decimal point.
NUM_PREC_RADIX Integer The radix, or base.
NULLABLE Integer Whether the column can contain null as defined by the following JDBC DatabaseMetaData constants: columnNoNulls (0) or columnNullable (1).
REMARKS String The comment or note associated with the object.
COLUMN_DEF String The default value for the column.
SQL_DATA_TYPE Integer Reserved by the specification.
SQL_DATETIME_SUB Integer Reserved by the specification.
CHAR_OCTET_LENGTH Integer The maximum length of binary and character-based columns.
ORDINAL_POSITION Integer The position of the column in the table, starting at 1.
IS_NULLABLE String Whether a null value is allowed: YES or NO.
IS_AUTOINCREMENT String Whether the column value is assigned by Active Directory in fixed increments.
IS_GENERATEDCOLUMN String Whether the column is generated: YES or NO.
DTS_TYPE String Object DTS attribute type.

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in Active Directory.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "User");
    LOGGER.info("\r\n" + resultSet.toString());
    Assertions.assertNotNull(resultSet);
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_NAME,PRIMARY_COLUMN_NAME
User,id

The getPrimaryKeys method returns the following columns:

Column Name Data Type Description
TABLE_NAME String The name of the table that contains the primary key.
PRIMARY_COLUMN_NAME String The name of the column that serves as the primary key for the table.

Connection Settings

Connection Setting Type Default Value Description
ApiThrottleRate Integer 10 The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second.
AuthenticationMode String "AuthorizationCode" AuthenticationMode specifies the method used to authenticate when connecting to Active Directory Azure API.
CacheExpirationTime Integer 30 Defines the expiration time for cache. A value of 0 disables caching.
CertificatePassword String "" The password used to access the keystore file.
ClientId String "" The ClientId used to access Active Directory.
ClientSecret String "" The ClientSecret used to access Active Directory.
ConcurrentWritingThreads Integer 1 The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
ConnectionTimeout Integer 30 ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the Active Directory API.
ConnectionType String "Azure" Determines the directory service environment to connect to.
IgnoreCertificateErrors Boolean false Specifies whether to verify the certificate when connecting to Active Directory. If no certificate verification is required, you can set this value to 'true'.
IgnoreError Boolean false Determines if the program continues executing SQL statements after encountering an error.
LogFileSize String "10485760" A string specifying the maximum size in bytes for a log file.
LogLevel String "INFO" The logging level for the JDBC driver.
LogPath String "./jdbcLogs" The directory where log files are stored.
MatchHandling String "writeOne" The strategy employed to address situations where multiple records meet the search criteria. Strategies are case-sensitive and include "writeAll" which will affect all matches, "writeOne" which will affect the first match, "ignoreAll" which will ignore all matches, and "raiseError" which will raise an error when multiple matches are found. By default, it is set to 'writeOne'.
OemKey String "" The OEM license key.
PathToCertificate String "" PathToCertificate specifies the file path where the keystore file for connecting to Active Directory API is located.
PathToTokenFile String "" The path to the token file.
ProxyMode String "NoProxy" This setting configures the proxy. Allowed values are "NoProxy", "AutoDetect" and "Manual".
ProxyPassword String "" The password to be used to authenticate to the proxy.
ProxyServer String "" The host of the proxy server.
ProxyServerPort Integer 0 The port of the proxy server.
ProxyUsername String "" The username to be used to authenticate to the proxy.
ReadBatchSize Integer 100 ReadBatchSize is used to set how many records can be read from Active Directory in a single call. Active Directory has a maximum ReadBatchSize of 999.
ResultPath String "" The path where the execution result files are saved.
RetryOnIntermittentErrors Boolean true The RetryOnIntermittentErrors parameter indicates whether to retry the connection when it might occasionally fail due to temporary issues.
SaveResult Boolean false The SaveResult parameter indicates whether to save the execution results to a file.
ServiceName String "ActiveDirectory" The ServiceName refers to the name of the service API selected by the user.
ServiceTimeout Integer 120 The ServiceTimeout is the timeout to receive the full response from Active Directory API.
Suppress404NotFoundError Boolean true When set to true, if a query results in an HTTP 404 error, a result set will still be created. When set to false, an error is logged instead and no result set is created.
TenantId String "" The Azure Tenant ID used to access Active Directory.
ThrottleRateUnit String "PerSecond" The unit of time for limiting API requests to avoid being throttled. Valid values include, "PerSecond", "PerMinute" and "PerHour".
TokenPassword String "" The password used to read the token file.
WriteBatchSize Integer 100 WriteBatchSize is used to set how many records can be written to Active Directory in a single call. At this time, Active Directory does not support batch writing. As such, the value of this property should be kept at 1.