All pages
Powered by GitBook
1 of 1

Loading...

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.

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

Field Values

Password

Field Values

Url

Field Values

FileRef

Field Values

OneTimeCode

Field Values

OneTimePassword

Field Values

Name

Field Values

Names

Field Values

BirthDate

Field Values

Date

Field Values

ExpirationDate

Field Values

Text

Field Values

SecurityQuestion

Field Values

SecurityQuestions

Field Values

Multiline

Field Values

Email

Field Values

CardRef

Field Values

AddressRef

Field Values

PinCode

Field Values

Phone

Field Values

Phones

Field Values

HiddenField

Field Values

SecureNote

Field Values

AccountNumber

Field Values

PaymentCard

Field Values

PaymentCards

Field Values

BankAccount

Field Values

BankAccounts

Field Values

KeyPair

Field Values

KeyPairs

Field Values

Host

Field Values

Hosts

Field Values

Address

Field Values

Addresses

Field Values

LicenseNumber

Field Values

KeeperFileData

Field Values

secret.data.getfield<FIELD_TYPE>()

No

null

enforceGeneration

Boolean

No

null

value

MutableList<String>

Yes

No

null

value

MutableList<String>

Yes

Yes

Yes

Yes

No

null

No

null

value

MutableList<Name>

Yes

No

null

value

MutableList<Long>

Yes

No

null

value

MutableList<Long>

Yes

No

null

value

MutableList<Long>

Yes

No

null

value

MutableList<String>

Yes

No

null

value

MutableList<SecurityQuestion>

Yes

No

null

value

MutableList<String>

Yes

No

null

value

MutableList<String>

Yes

No

null

value

MutableList<String>

Yes

No

null

value

MutableList<String>

Yes

Yes

No

null

type

String

No

null

No

null

value

List<Phone>

Yes

Yes

No

null

value

List<String>

Yes

No

null

value

List<String>

Yes

No

null

No

null

value

MutableList<PaymentCard>)

Yes

No

null

otherType

String

No

null

No

null

value

MutableList<BankAccount>)

Yes

No

null

value

MutableList<KeyPair>

Yes

No

null

value

MutableList<Host>

Yes

No

null

state

String

No

null

county

String

No

null

zip

String

No

null

No

null

value

MutableList<Address>

Yes

No

null

value

MutableList<String>

Yes

Yes

size

Long

Yes

lastModified

Long

Yes

Name

Type

Required

Default

lbl

String

No

null

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

value

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

value

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

value

Name

Type

Required

Default

first

String

No

null

middle

String

No

null

last

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

question

String

No

null

answer

String

No

null

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

Label

String

No

null

required

Boolean

No

null

value

Name

Type

Required

Default

region

String

No

null

number

String

No

null

ext

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

value

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

cardNumber

String

No

null

cardExpirationDate

String

No

null

cardSecurityCode

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

accountType

String

No

null

routingNumber

String

No

null

accountNumber

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

publicKey

String

no

null

privateKey

String

no

null

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

hostName

String

No

null

port

String

No

null

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

street1

String

No

null

street2

String

No

null

city

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

label

String

No

null

required

Boolean

No

null

privacyScreen

Name

Type

Required

Default

title

String

Yes

name

String

Yes

type

Boolean

Boolean

MutableList<String>

MutableList<String>

MutableList<String>

String

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

MutableList<String>

String

Boolean

List<String>

Boolean

Boolean

String

Boolean

String

Boolean

Boolean

Boolean

String

Boolean

Boolean

String

sealed class KeeperRecordField(val lbl: String? = 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>
)
data class Url(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
data class FileRef(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
data class OneTimeCode(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
data class OneTimePassword(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
data class Name(var first: String? = null, var middle: String? = null, var last: String? = null)
data class Names(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Name>)
data class BirthDate(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)
data class Date(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)
data class ExpirationDate(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Long>)
data class Text(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, var value: MutableList<String>)
data class SecurityQuestion(var question: String? = null, var answer: String? = null)
data class SecurityQuestions(
    var label: String? = null,
    var required: Boolean? = null,
    var privacyScreen: Boolean? = null,
    val value: MutableList<SecurityQuestion>
)
data class Multiline(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
data class Email(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
data class CardRef(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
data class AddressRef(var label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
data class PinCode(var label: String? = null, var required: Boolean? = null, val value: MutableList<String>)
data class Phone(
    val region: String? = null,
    val number: String? = null,
    val ext: String? = null,
    val type: String? = null
)
data class Phones(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<Phone>)
data class HiddenField(val label: String? = null, var required: Boolean? = null, val value: List<String>)
data class SecureNote(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<String>)
data class AccountNumber(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: List<String>)
data class PaymentCard(
    var cardNumber: String? = null,
    var cardExpirationDate: String? = null,
    var cardSecurityCode: String? = null
)
data class PaymentCards(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<PaymentCard>) :
data class BankAccount(
    var accountType: String? = null,
    var routingNumber: String? = null,
    var accountNumber: String? = null,
    var otherType: String? = null
)
data class BankAccounts(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<BankAccount>) :
data class KeyPair(
    val publicKey: String? = null,
    val privateKey: String? = null,
)
data class KeyPairs(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<KeyPair>)
data class Host(
    val hostName: String? = null,
    val port: String? = null,
)
data class Hosts(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Host>)
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
)
data class Addresses(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<Address>)
data class LicenseNumber(val label: String? = null, var required: Boolean? = null, var privacyScreen: Boolean? = null, val value: MutableList<String>)
data class KeeperFileData(
    val title: String,
    val name: String,
    val type: String,
    val size: Long,
    val lastModified: Long
)