Token
March 5, 2024
ID 224177
Specifies parameters of an API token, such as its name and value. In the AccessTokens element, there can be several Token elements.
If the element UseAccessToken is set to 1, there must be at least one Token element and it cannot be empty.
Path
ServerSettings > AuthSettings > AccessTokens > Token
Nested elements
This element is a container for the following nested elements:
- Name;
- Value;
- Description;
- Enabled.
See the description of these elements below.
Token > Name
The unique name of the token. Each token in the AccessTokens element must have a unique name.
The name must contain from 1 to 40 Unicode characters.
If the element UseAccessToken is set to 1, there must be at least one Name element and it cannot be empty.
Token > Value
An element containing the encrypted value of the API token, 88 ASCII characters long.
Do not specify this value directly in the configuration file; use the Kaspersky Scan Engine GUI or kl_access_util instead. When the token is added via Kaspersky Scan Engine GUI or kl_access_util, its value is being encrypted. Do not put the original token in the Value element.
If the element UseAccessToken is set to 1, there must be at least one Value element and it cannot be empty.
Token > Description
The description contains additional information about the token. For example, the name of the client that uses the token, or the date and time the token was created.
The description can contain up to 1000 Unicode characters.
This element is optional.
Token > Enabled
Indicates whether Kaspersky Scan Engine should authorize clients that specified the token in the request header.
Possible values:
0—The token is disabled. Kaspersky Scan Engine does not authorize clients that specified the token in the request header.1—The token is enabled. Kaspersky Scan Engine can authorize clients that specified the token in the request header.
If the element UseAccessToken is set to 1, there must be at least one Enabled element and it cannot be empty.
Example
The following is an example of the Token element.
<Token> <Name>Unlimited key</Name> <Value>SldYQTUyOUNVMnE3VWR2N3Izamk2QkVNc2hhLTV5dTBLcVUzeXZLdGYtNkkrVFUyQUVRQUNLQUFCSWdwRUlJTQ==</Value> <Description>Kaspersky Scan Engine Clients. Full access scope</Description> <Enabled>1</Enabled> </Token> |
