Description of each accessible field type Class in the Keeper Secrets Manager Java SDK
Use the getField
function to access record fields.
secret.data.getfield<FIELD_TYPE>()
The 'FIELD_TYPE' needs to be a class from the list below.
All Record Fields extend the KeeperRecordField class, and contain a lbl field
sealed class KeeperRecordField(val lbl: String? = null)
Name
Type
Required
Default
lbl
String
No
null
data class Password(
var label: String? = null,
var required: Boolean? = null,
var privacyScreen: Boolean? = null,
var enforceGeneration: Boolean? = null,
var complexity: PasswordComplexity? = null,
val value: MutableList<String>
)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
enforceGeneration
Boolean
No
null
value
MutableList<String>
Yes
data class Url(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class FileRef(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
value
MutableList<String>
Yes
data class OneTimeCode(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
value
MutableList<String>
Yes
data class OneTimePassword(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
value
MutableList<String>
Yes
data class Name(var first: String? = null, var middle: String? = null, var last: String? = null)
Name
Type
Required
Default
first
String
No
null
middle
String
No
null
last
String
No
null
data class Names(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Name>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<Name>
Yes
data class BirthDate(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<Long>
Yes
data class Date(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<Long>
Yes
data class ExpirationDate(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<Long>
Yes
data class Text(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, var value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class SecurityQuestion(var question: String? = null, var answer: String? = null)
Name
Type
Required
Default
question
String
No
null
answer
String
No
null
data class SecurityQuestions(
var label: String? = null,
var required: Boolean? = null,
var privacyScreen: Boolean? = null,
val value: MutableList<SecurityQuestion>
)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<SecurityQuestion>
Yes
data class Multiline(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class Email(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class CardRef(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class AddressRef(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class PinCode(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
Label
String
No
null
required
Boolean
No
null
value
MutableList<String>
Yes
data class Phone(
val region: String? = null,
val number: String? = null,
val ext: String? = null,
val type: String? = null
)
Name
Type
Required
Default
region
String
No
null
number
String
No
null
ext
String
No
null
type
String
No
null
data class Phones(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<Phone>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
List<Phone>
Yes
data class HiddenField(val label: String? = null, var required: Boolean? = null, val value: List<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
value
List<String>
Yes
data class SecureNote(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
List<String>
Yes
data class AccountNumber(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
List<String>
Yes
data class PaymentCard(
var cardNumber: String? = null,
var cardExpirationDate: String? = null,
var cardSecurityCode: String? = null
)
Name
Type
Required
Default
cardNumber
String
No
null
cardExpirationDate
String
No
null
cardSecurityCode
String
No
null
data class PaymentCards(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<PaymentCard>) :
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<PaymentCard>)
Yes
data class BankAccount(
var accountType: String? = null,
var routingNumber: String? = null,
var accountNumber: String? = null,
var otherType: String? = null
)
Name
Type
Required
Default
accountType
String
No
null
routingNumber
String
No
null
accountNumber
String
No
null
otherType
String
No
null
data class BankAccounts(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<BankAccount>) :
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<BankAccount>)
Yes
data class KeyPair(
val publicKey: String? = null,
val privateKey: String? = null,
)
Name
Type
Required
Default
publicKey
String
no
null
privateKey
String
no
null
data class KeyPairs(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<KeyPair>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<KeyPair>
Yes
data class Host(
val hostName: String? = null,
val port: String? = null,
)
Name
Type
Required
Default
hostName
String
No
null
port
String
No
null
data class Hosts(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Host>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<Host>
Yes
data class Address(
val street1: String? = null,
val street2: String? = null,
val city: String? = null,
val state: String? = null,
val country: String? = null,
val zip: String? = null
)
Name
Type
Required
Default
street1
String
No
null
street2
String
No
null
city
String
No
null
state
String
No
null
county
String
No
null
zip
String
No
null
data class Addresses(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Address>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<Address>
Yes
data class LicenseNumber(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
Name
Type
Required
Default
label
String
No
null
required
Boolean
No
null
privacyScreen
Boolean
No
null
value
MutableList<String>
Yes
data class KeeperFileData(
val title: String,
val name: String,
val type: String,
val size: Long,
val lastModified: Long
)
Name
Type
Required
Default
title
String
Yes
name
String
Yes
type
String
Yes
size
Long
Yes
lastModified
Long
Yes