KSC Open API
Kaspersky Security Center API description
Product backend commands list

Supported commands and their parameters

"RefreshIntegrationToken" - renew integration access/refresh token pair


Parameters:

AttributeTypeDescription
REFRESH_TOKENparamBinaryIntegration refresh token body


Result:

AttributeTypeDescription
ACCESS_TOKENparamBinaryNew integration access token body
ACCESS_TOKEN_TTLintTime to live of access token in seconds, since this command processing time
REFRESH_TOKENparamBinaryNew integration refresh token body
REFRESH_TOKEN_TTLintTime to live of refresh token in seconds, since this command processing time


"IssueUserToken" - get new user access/refresh token pair


Parameters:

AttributeTypeDescription
CMD_ACCESS_TOKENparamBinaryIntegration access token
CMD_SERVER_IDparamStringNative server ID
CMD_VSERVER_NAMEparamStringVirtual server name
CMD_USER_IDparamStringUser ID
CMD_USER_NAMEparamStringUser display name
CMD_USER_PERMISSIONSparamParamsUser permissions to product; Format:
        +--- CMD_USER_PERMISSIONS (paramParams)
            +---<functional area> = (paramInt)<access mask> // see Access rights
        


Command result is not used by KSC server and is passed as is to command initiator


"RevokeUserToken" - revoke all tokens for specific user


Parameters:

AttributeTypeDescription
CMD_ACCESS_TOKENparamBinaryIntegration access token
CMD_SERVER_IDparamStringNative server ID
CMD_VSERVER_NAMEparamStringVirtual server name
CMD_USER_IDparamStringUser ID
CMD_USER_NAMEparamStringUser display name


Command result is not used by KSC server and is passed as is to command initiator


"RevokeAllUserTokens" - revoke all user tokens issued with specified integration token


Parameters:

AttributeTypeDescription
ACCESS_TOKENparamBinaryIntegration access token body


Command result is not used by KSC server and is passed as is to command initiator

See also:
Product backend commands