Enumerations and Bitsets

AuthenticationMode

Represents the authentication mode.

Objective-C - KSMAuthenticationMode

Java - AuthenticationMode

Values

Java	Objective-C	Description
NO	KSMAuthenticationModeNo	Indicates that no interactive authentication is required to access user credentials.
BIOMETRIC	KSMAuthenticationModeBiometric	Indicates that biometric authentication is required to access user credentials.
PASSWORD	KSMAuthenticationModePassword	Indicates that password authentication is required to access user credentials.
PIN	KSMAuthenticationModePin	Indicates that device PIN authentication is required to access user credentials.

BannerType

Represents the banner type.

Objective-C - KSMBannerType

Java - BannerType

Values

Java	Objective-C	Description
DISPLAY_MESSAGE	KSMBannerTypeDisplayMessage	Indicates that a display message is waiting to be processed.
TRANSACTION	KSMBannerTypeTransaction	Indicates that a transaction is waiting to be processed.

ConfirmationType

Represents the transaction confirmation type

Objective-C - KSMConfirmationType

Java - ConfirmationType

Values

Java	Objective-C	Description
OK	KSMConfirmationTypeOk	Indicates that the transaction is successfully processed and accepted.
CANCEL	KSMConfirmationTypeCancel	Indicates that transaction processing is cancelled.
TIMEOUT	KSMConfirmationTypeTimeout	Indicates that transaction processing is timed out.

KeyAccessProtectionMode

Represents the key access protection mode.

Value	Description
No	Indicates that no interactive authentication is required to access keys from the device key strorage.
Biometric	Indicates that biometric authentication is required to access user keys from the device key strorage.
DeviceCredential	Indicates that device PIN is required to access user keys from the device key strorage.

MessageType

Represents the display message type

Objective-C - KSMMessageType

Java - MessageType

Values

Java	Objective-C	Description
INFO	KSMMessageTypeInfo	Indicates an info display message
WARNING	KSMMessageTypeWarning	Indicates an warning display message
ERROR	KSMMessageTypeError	Indicates an error display message

SdkState

Represents the SDK state.

Objective-C - KSMSdkState

Java - SdkState

Values

Java	Objective-C	Description
UNINITIALISED	KSMUninitialised	Indicates that the SDK has failed to initialise. Check the error code and description in the result event.
ACTIVATION_REQUIRED	KSMActivationRequired	Indicates that the SDK has successfully initialised but there are no activated users.
LOGIN_REQUIRED	KSMLoginRequired	Indicates that the SDK has successfully initialised, and there are already some activated users who may log in. The activated user list is provided in the result event.
UNIDENTIFIED	KSMUnidentified	Indicates that the SDK has successfully initialized, but some internal error occurred during user activation or deactivation. Check the error code and description in the result event.

StatusType

Objective-C - KSMEventStatusType

Java - StatusType

Values

Java	Objective-C	Description
OK	KSMOK	The process was completed successfully.
UPDATE_AVAILABLE	KSMUPDATE_AVAILABLE	An update of the app is available. (Info only)
APP_REGISTERED	KSMAPP_REGISTERED	Will be sent from SSMS to the app when the app registration was successful. (Info only). The App must restart the SDK itself.
USER_CANCEL	KSMUSER_CANCEL	The user cancelled a process, e.g. a transaction.
USER_CONFIRMATION_TIMEOUT	KSMUSER_CONFIRMATION_TIMEOUT	The process was cancelled by a timeout.
INVALID_PIN	KSMINVALID_PIN	The user entered a wrong pin.
UNKNOWN_VERSION	KSMUNKNOWN_VERSION	Activation and Logon process: The app has a wrong version.
UNKNOWN_CLIENT_TYPE	KSMUNKNOWN_CLIENT_TYPE	Activation and Logon process: The app has a wrong client type.
UPDATE_NECESSARY	KSMUPDATE_NECESSARY	This version of the app was replace by a newer one and the user must update.
WRONG_CREDENTIALS	KSMWRONG_CREDENTIALS	Activation and Logon process: The user ID, activation code or the PIN are incorrect.
UNKNOWN_CERTIFICATE	KSMUNKNOWN_CERTIFICATE	User removed on the ssms server
INTERNAL_ERROR	KSMINTERNAL_ERROR	An internal error occurred during the process, usually a Runtimer Error
ACTIVATION_CODE_EXPIRED	KSMACTIVATION_CODE_EXPIRED	Activation process: The activation code expired.
LOCKED_CERTIFICATE	KSMLOCKED_CERTIFICATE	User locked on ssms server
LOCKED_USER	KSMLOCKED_USER	User locked on ssms server
PROPERTY_NOT_EXISTS	KSMPROPERTY_NOT_EXISTS	Requested property is not stored on SSMS or local DataBase.
INVALID_KEY_LENGTH	KSMINVALID_KEY_LENGTH	Property key is too long.
NOT_UNIQUE	KSMNOT_UNIQUE	Sent property string is not unique for this user.
TEXT_TOO_LONG	KSMTEXT_TOO_LONG	Sent property string is too long.
INVALID_STATE	KSMINVALID_STATE	The MasterController is in a state where it can't proceed the corresponding event.
INVALID_PARAMETER	KSMINVALID_PARAMETER	One of the parameters of the invoked event has an invalid format
INVALID_USER_ID	KSMINVALID_USER_ID	The given userID is invalid (e.g. no user credentials are available)
USER_ID_ALREADY_EXISTS	KSMUSER_ID_ALREADY_EXISTS	User credentials already exists for the given userID at the user credential path
REGISTER_APP	KSMREGISTER_APP	The app isn't registered at SSMS
MISMATCHED_USER	KSMMISMATCHED_USER	The certificate doesn't match to the user (e.g. typing error for the userID)
NEGATIVE	KSMNEGATIVE	A negative status has been occured usually this comes with an additional errorCode and subSystem
READ_ONLY	KSMREAD_ONLY	Requested property is a read only property
TEMPORARY_LOCKED	KSMTEMPORARY_LOCKED	Logon process: The user ID is temporary locked by entering wrong PINs.
NOT_SUSPENDED	KSMNOT_SUSPENDED	Resume has been invoked although MasterController had not been suspended before
INVALID_PASSWORD	KSMINVALID_PASSWORD	Invalid password for the keystorage was provided
PASSWORD_BLOCKED	KSMPASSWORD_BLOCKED	Password for the keytorage is blocked
ATC_EXPIRES_SOON	KSMATC_EXPIRES_SOON	The ATC used for the OfflineFunctions will soon expire
ATC_EXPIRED	KSMATC_EXPIRED	The ATC used for the OfflineFunctions is expired
NOT_REACHABLE	KSMNOT_REACHABLE	Operation could not be completed, because connection to SSMS was lost
PIN_BLOCKED	KSMPIN_BLOCKED	The PIN is blocked
ACCESS_DENIED	KSMACCESS_DENIED	The requested property cannot be accessed by the App
PROPERTY_EXISTS	KSMPROPERTY_EXISTS	The requested property exists
TENANT_ID_ALREADY_SET	KSMTENANT_ID_ALREADY_SET	If the Tenant ID has already been set in the sdk config, it is not allowed to set it via doActivation. If a user still tries to set it this status code is returned with onActivationEnd */
UNINITIALIZED	KSMUNINITIALIZED	The underlaying module necessary to execute the invoked event is uninitialised
FAILED	KSMFAILED	The execution of the invoked event failed. Usually this cannot be fixed from App side and a Restart is necessary
LOGIN_REQUIRED	KSMLOGIN_REQUIRED	The execution of tehinvoked event requires an online login
ALREADY_INITIALIZED	KSMALREADY_INITIALIZED	The underlaying module necessary to execute the invoked event is already initialised
GLOBAL_PIN_SET	KSMGLOBALPINSET	Activation was successful and the global PIN for the given user had been set
UPDATE_AVAILABLE_GLOBAL_PIN_SET	KSMUPDATE_AVAILABLE_GLOBAL_PIN_SET	An update is available for the App but the global PIN had been set
INVALID_TOKEN	KSMINVALID_TOKEN	An invalid token had been provided for a transaction
OFFLINE_NOT_ACTIVATED	KSMOFFLINE_NOT_ACTIVATED	The invoked event needs offline capabilities which had not been activated before
NOT_SUPPORTED	KSMNOT_SUPPORTED	The invoked event is not supported with teh given configuration
CONNECTION_LOST	KSMCONNECTION_LOST	The invoked event requires vaid IDP Token data which are not available
NO_TOKEN_DATA_AVAILABLE	KSMNO_TOKEN_DATA_AVAILABLE	The invoked event requires vaid IDP Token data but available data is expired
TOKEN_DATA_IS_OUTDATED	KSMTOKEN_DATA_IS_OUTDATED	An error occured while trying to acquire fresh IDP tokens from IDP
CANNOT_ACQUIRE_TOKEN_DATA	KSMCANNOT_ACQUIRE_TOKEN_DATA	An error occured while trying to acquire an authorization code from IDP
CANNOT_ACQUIRE_AUTHORIZATION_CODE	KSMCANNOT_ACQUIRE_AUTHORIZATION_CODE	An error occured while trying to acquire fresh IDP tokens from IDP via the an acquired authorisation code
CANNOT_ACQUIRE_ACCESS_TOKEN_FOR_AUTHORIZATION_CODE	KSMCANNOT_ACQUIRE_ACCESS_TOKEN_FOR_AUTHORIZATIN_CODE	The operation cancelled on server side, e.g. a transaction.
SERVER_CANCEL	KSMSERVER_CANCEL	The underlying operation could not be completed due to connection issues. Used in DisplayConfirmationResult and TransactionEnd events.

SupportedFeatures

A bitset used to inform about the supported features.

Objective-C - KSMSupportedFeatures

Java - SupportedFeatures

Values

Java	Objective-C	Description
SECURE_ELEMENT bit is set	KSMSecureElement	Indicates that Secure Element is supported on the device