Record Field Classes

Description of each accessible field type Class in the Keeper Secrets Manager Java SDK

Accessing Record Fields

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.

Field Type Classes Reference

KeeperRecordField

All Record Fields extend the KeeperRecordField class, and contain a lbl field

sealed class KeeperRecordField(val lbl: String? = null)

Field Values

Name	Type	Required	Default
lbl	String	No	null

Password

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>
)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
enforceGeneration	Boolean	No	null
value	MutableList<String>	Yes

Url

data class Url(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

FileRef

data class FileRef(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
value	MutableList<String>	Yes

OneTimeCode

data class OneTimeCode(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
value	MutableList<String>	Yes

OneTimePassword

data class OneTimePassword(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
value	MutableList<String>	Yes

Name

data class Name(var first: String? = null, var middle: String? = null, var last: String? = null)

Field Values

Name	Type	Required	Default
first	String	No	null
middle	String	No	null
last	String	No	null

Names

data class Names(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Name>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<Name>	Yes

BirthDate

data class BirthDate(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<Long>	Yes

Date

data class Date(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<Long>	Yes

ExpirationDate

data class ExpirationDate(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<Long>	Yes

Text

data class Text(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, var value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

SecurityQuestion

data class SecurityQuestion(var question: String? = null, var answer: String? = null)

Field Values

Name	Type	Required	Default
question	String	No	null
answer	String	No	null

SecurityQuestions

data class SecurityQuestions(
    var label: String? = null,
    var required: Boolean? = null,
    var privacyScreen: Boolean? = null,
    val value: MutableList<SecurityQuestion>
)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<SecurityQuestion>	Yes

Multiline

data class Multiline(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

Email

data class Email(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

CardRef

data class CardRef(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

AddressRef

data class AddressRef(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

PinCode

data class PinCode(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
Label	String	No	null
required	Boolean	No	null
value	MutableList<String>	Yes

Phone

data class Phone(
    val region: String? = null,
    val number: String? = null,
    val ext: String? = null,
    val type: String? = null
)

Field Values

Name	Type	Required	Default
region	String	No	null
number	String	No	null
ext	String	No	null
type	String	No	null

Phones

data class Phones(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<Phone>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	List<Phone>	Yes

HiddenField

data class HiddenField(val label: String? = null, var required: Boolean? = null, val value: List<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
value	List<String>	Yes

SecureNote

data class SecureNote(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	List<String>	Yes

AccountNumber

data class AccountNumber(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	List<String>	Yes

PaymentCard

data class PaymentCard(
    var cardNumber: String? = null,
    var cardExpirationDate: String? = null,
    var cardSecurityCode: String? = null
)

Field Values

Name	Type	Required	Default
cardNumber	String	No	null
cardExpirationDate	String	No	null
cardSecurityCode	String	No	null

PaymentCards

data class PaymentCards(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<PaymentCard>) :

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<PaymentCard>)	Yes

BankAccount

data class BankAccount(
    var accountType: String? = null,
    var routingNumber: String? = null,
    var accountNumber: String? = null,
    var otherType: String? = null
)

Field Values

Name	Type	Required	Default
accountType	String	No	null
routingNumber	String	No	null
accountNumber	String	No	null
otherType	String	No	null

BankAccounts

data class BankAccounts(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<BankAccount>) :

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<BankAccount>)	Yes

KeyPair

data class KeyPair(
    val publicKey: String? = null,
    val privateKey: String? = null,
)

Field Values

Name	Type	Required	Default
publicKey	String	no	null
privateKey	String	no	null

KeyPairs

data class KeyPairs(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<KeyPair>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<KeyPair>	Yes

Host

data class Host(
    val hostName: String? = null,
    val port: String? = null,
)

Field Values

Name	Type	Required	Default
hostName	String	No	null
port	String	No	null

Hosts

data class Hosts(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Host>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<Host>	Yes

Address

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
)

Field Values

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

Addresses

data class Addresses(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Address>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<Address>	Yes

LicenseNumber

data class LicenseNumber(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)

Field Values

Name	Type	Required	Default
label	String	No	null
required	Boolean	No	null
privacyScreen	Boolean	No	null
value	MutableList<String>	Yes

KeeperFileData

data class KeeperFileData(
    val title: String,
    val name: String,
    val type: String,
    val size: Long,
    val lastModified: Long
)

Field Values

Name	Type	Required	Default
title	String	Yes
name	String	Yes
type	String	Yes
size	Long	Yes
lastModified	Long	Yes