Comment on page
Record Field Classes

Description of each accessible field type Class in the Keeper Secrets Manager Go SDK
Accessing Record Fields
Use the GetFieldByType function to access record fields.
loginField, ok := secret.GetFieldByType(ksm.Login{}).(*ksm.Login)
Field Type Classes Reference
KeeperRecordField
All Record Fields extend the KeeperRecordField class, and contain a Label and Type fields
type KeeperRecordField struct {
	Type  string `json:"type"`
	Label string `json:"label,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Type
string
Yes
""
Password
type Password struct {
	KeeperRecordField
	Required          bool               `json:"required,omitempty"`
	PrivacyScreen     bool               `json:"privacyScreen,omitempty"`
	EnforceGeneration bool               `json:"enforceGeneration,omitempty"`
	Complexity        PasswordComplexity `json:"complexity,omitempty"`
	Value             []string           `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
EnforceGeneration
bool
No
false
Value
[]string
Yes
​
Url
type Url struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
FileRef
type FileRef struct {
	KeeperRecordField
	Required bool     `json:"required,omitempty"`
	Value    []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
Value
[]string
Yes
​
OneTimeCode
type OneTimeCode struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
Name
type Name struct {
	First  string `json:"first,omitempty"`
	Middle string `json:"middle,omitempty"`
	Last   string `json:"last,omitempty"`
}
Field Values
Name
Type
Required
Default
First
string
No
""
Middle
string
No
""
Last
string
No
""
Names
type Names struct {
	KeeperRecordField
	Required      bool   `json:"required,omitempty"`
	PrivacyScreen bool   `json:"privacyScreen,omitempty"`
	Value         []Name `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]Name
Yes
​
BirthDate
type BirthDate struct {
	KeeperRecordField
	Required      bool    `json:"required,omitempty"`
	PrivacyScreen bool    `json:"privacyScreen,omitempty"`
	Value         []int64 `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]int64
Yes
​
Date
type Date struct {
	KeeperRecordField
	Required      bool    `json:"required,omitempty"`
	PrivacyScreen bool    `json:"privacyScreen,omitempty"`
	Value         []int64 `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]int64
Yes
​
ExpirationDate
type ExpirationDate struct {
	KeeperRecordField
	Required      bool    `json:"required,omitempty"`
	PrivacyScreen bool    `json:"privacyScreen,omitempty"`
	Value         []int64 `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]int64
Yes
​
Text
type Text struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
SecurityQuestion
type SecurityQuestion struct {
	Question string `json:"question,omitempty"`
	Answer   string `json:"answer,omitempty"`
}
Field Values
Name
Type
Required
Default
Question
string
No
""
Answer
string
No
""
SecurityQuestions
type SecurityQuestions struct {
	KeeperRecordField
	Required      bool               `json:"required,omitempty"`
	PrivacyScreen bool               `json:"privacyScreen,omitempty"`
	Value         []SecurityQuestion `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]SecurityQuestion
Yes
​
Multiline
type Multiline struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
Email
type Email struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
CardRef
type CardRef struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
AddressRef
type AddressRef struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
PinCode
type PinCode struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
Phone
type Phone struct {
	Region string `json:"region,omitempty"`
	Number string `json:"number,omitempty"`
	Ext    string `json:"ext,omitempty"`
	Type   string `json:"type,omitempty"`
}
Field Values
Name
Type
Required
Default
Region
string
No
""
Number
string
No
""
Ext
string
No
""
Type
string
No
""
Phones
type Phones struct {
	KeeperRecordField
	Required      bool    `json:"required,omitempty"`
	PrivacyScreen bool    `json:"privacyScreen,omitempty"`
	Value         []Phone `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]Phone
Yes
​
Secret
type Secret struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
SecureNote
type SecureNote struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
AccountNumber
type AccountNumber struct {
	KeeperRecordField
	Required      bool     `json:"required,omitempty"`
	PrivacyScreen bool     `json:"privacyScreen,omitempty"`
	Value         []string `json:"value,omitempty"`
}
Field Values
Name
Type
Required
Default
Label
string
No
""
Required
bool
No
false
PrivacyScreen
bool
No
false
Value
[]string
Yes
​
PaymentCard
type PaymentCard struct {
	CardNumber         string `json:"cardNumber,omitempty"`
	CardExpirationDate string `json:"cardExpirationDate,omitempty"`
	CardSecurityCode   string `json:"cardSecurityCode,omitempty"`
}
Field Values
Name
Type
Required
Default
CardNumber
string
No
""
CardExpirationDate
string
No
Name	Type	Required	Default
`Label`	`string`	No	`""`
`Required`	`bool`	No	`false`
`PrivacyScreen`	`bool`	No	`false`
`EnforceGeneration`	`bool`	No	`false`
`Value`	`[]string`	Yes
Name	Type	Required	Default
`Label`	`string`	No	`""`
`Required`	`bool`	No	`false`
`PrivacyScreen`	`bool`	No	`false`
`Value`	`[]string`	Yes
Name	Type	Required	Default
`Label`	`string`	No	`""`
`Required`	`bool`	No	`false`
`Value`	`[]string`	Yes
Name	Type	Required	Default
`Label`	`string`	No	`""`
`Required`	`bool`	No	`false`
`PrivacyScreen`	`bool`	No	`false`
`Value`	`[]string`	Yes
Name	Type	Required	Default
`First`	`string`	No	`""`
`Middle`	`string`	No	`""`
`Last`	`string`	No	`""`