Secret Property

The Base32 encoded shared secret used when creating and validating a password.

Object Oriented Interface

public function getSecret();
public function setSecret($value);

Procedural Interface

ipworksencrypt_onetimepassword_get($res, 4 );
ipworksencrypt_onetimepassword_set($res, 4, $value );

Default Value

''

Remarks

This property specifies the Base32 encoded shared secret used when creating and validating a password. This should be set before calling CreatePassword or ValidatePassword.

If this is not set before calling CreatePassword a random secret will be automatically generated. This functionality provides an easy way to create new secret values. The length of the secret is defined by SecretLength.

Data Type

String