KSC Open API
Kaspersky Security Center API description
|
To execute XRDO response one should create a gateway connection to the host, and call NagGuiCalls::CallConnectorAsync method, specifying szwProduct="1103", szwVersion="1.0.0.0".
Values for szwCallName (name of the gui call) and pInData (guicall parameters) are listed below.
Checks login and password used to create the context.
szwCallName=KLNAG_XDRO_RSP_CHECK_LOGIN
Container pInData must contain following attributes:
Name | Type | Description | Remarks |
---|---|---|---|
"KLXDRO_DOMAIN_NAME" | paramString | Active Directory domain name stored via the KlXdroRspAdUaData::RelationAdd method. | Active Directory domain name in lowercase FQDN format, e.g. "mycompany.com". |
"KLXDRO_LOGIN" | paramString | Login name of the Active Directory user able to perform XDRO response. | |
"KLXDRO_PASSWORD" | paramBinary | Password of the Active Directory user able to perform XDRO response. | The password must be protected with DataProtectionApi::ProtectUtf8StringForHost |
"XDRO_RSP_CHECK_LOGIN_CONTROLLERS" | paramArray | Array of string, each string is a domain controller address | Each domain controller address may be either DNS name or NetBIOS name or IP address |
Gui call result must contain "XDRO_RSP_CHECK_LOGIN_RESULTS" variable which is array of containers where each container must following variables:
Length of the Array XDRO_RSP_CHECK_LOGIN_RESULTS must be the same as length of the array XDRO_RSP_CHECK_LOGIN_CONTROLLERS.
Adjusts user account: locks it or makes the user to change the password during the next login.
szwCallName=KLNAG_XDRO_RSP_ADJUST_USER
Container pInData must contain following attributes:
Name | Type | Description | Remarks |
---|---|---|---|
"KLXDRO_GUICALL_CONTEXT" | paramBinary | Context acquired from RspAdUaRelation::MakeupContextForResponse method. | |
"KLXDRO_DOMAIN_NAME" | paramString | Active Directory domain name stored via the KlXdroRspAdUaData::RelationAdd method. | Active Directory domain name in lowercase FQDN format, e.g. "mycompany.com". |
"KLXDRO_USER_DISTINGUISHED_NAME" | paramString | Active Directory distinguished name of the target user account. | Something like "CN=UserName,OU=Users,DC=mycompany,DC=com". |
"KLXDRO_ADJUST_USER_OPERATION" | paramInt | Code of operation. | One of the values:
|
Adjusts user's membership list: add or remove specified group.
szwCallName=KLNAG_XDRO_RSP_ADJUST_MEMBERSHIP
Container pInData must contain following attributes:
Name | Type | Description | Remarks |
---|---|---|---|
"KLXDRO_GUICALL_CONTEXT" | paramBinary | Context acquired from RspAdUaRelation::MakeupContextForResponse method. | |
"KLXDRO_DOMAIN_NAME" | paramString | Active Directory domain name stored via the KlXdroRspAdUaData::RelationAdd method. | Active Directory domain name in lowercase FQDN format, e.g. "mycompany.com". |
"KLXDRO_USER_DISTINGUISHED_NAME" | paramString | Active Directory distinguished name of the user account whose membership is to be adjusted. | Something like "CN=UserName,OU=Users,DC=mycompany,DC=com". |
"KLXDRO_GROUP_DISTINGUISHED_NAME" | paramString | Active Directory distinguished name of the security group which must be added to (or removed from) user's membership list. | Something like "CN=GroupName,OU=Groups,DC=mycompany,DC=com". |
"KLXDRO_ADJUST_MEMBERSHIP_OPERATION" | paramInt | Code of operation. | One of the values:
|