SmartAgentStatus

Description

A read only object that contains all the necessary information about the Smart Agent account. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)

Supported Operations

Model Properties

Property Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
registrationStatus False string An enum which specifies the different states the user can be with regards to Registration. The values can be one of the following.
EVAL - The product is in Evaluation mode.
REGISTERED - The product is in the registered state.
RENEW_CERT_FAILED - Specifies if the renewal failed.
UNREGISTERED - The product is unregistered. In this state, when the renew fails repeatedly, the user chooses to deregister or their eval mode ends.
registrationTimeStamp False integer An integer which tells when the user registered or renewed their certificate. This uses Unix epoch time(number of seconds since January 1, 1970 not counting leap seconds).
authorizationStatus False string An enum which specifies the different states the user can be with regards to Authorization. The values can be one of the following.
AUTHORIZED - The product is authorized and has a valid auth.
AUTH_EXPIRED - The product's authorization is expired.
EVAL - The product is in Evaluation mode.
NOT_AUTHORIZED - The product is no longer authorized.
OUT_OF_COMPLIANCE - There are some issues in your account or your licenses are out of compliance.
RENEW_AUTH_FAILED - Renewal of the product failed.
UNREGISTERED - The product is not registered currently.
authorizationTimeStamp False integer A long integer which tells when the user last was authorized. This uses Unix epoch time (number of seconds since January 1, 1970 not counting leap seconds).
virtualAccount False string A string specifying the name associated with the virtual account holder. The string cannot have HTML tags or SQL characters.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
exportControl False boolean A boolean value, TRUE or FALSE. The value TRUE specifies that the account has export control enabled. The value FALSE specifies that the account does not have export control enabled.
evaluationStartTime False integer An integer, which contains the start time in seconds. If the user registered during Device Initial setup, this value will be set to the registration timestamp. This value can be set to null in case Smart Agent is not in EVAL mode.
evaluationRemainingDays False integer An integer which specifies the remaining days in evaluation period. If the user is registered or their evaluation mode has expired, this will be 0.
syncTimeStamp False integer An integer which specifies when the user has last synced in milliseconds. This will also be the timestamp when syncd last ran.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.