Field/Record Types

Field Types

Field types defined how a field's data is stored. Field types are used in the default record type and user created custom records.

accountNumber

A string value. There is no validation of the value.

address

A dictionary value containing:

• street1 - Street address 1

• street2 - Street address 2

• city - City

• state - State

• zip - Postal code

None of the keys are required.

Example:

bankAccount

A dictionary value containing:

• accountType - Checking | Savings | Other

• otherType - Description of the other account type

• routingNumber - The bank routing number

• accountNumber - The account number

None of the keys are required.

Example:

birthDate

A epoch milliseconds value. Depending on method of creation, ie using a helper modules, an ISO8601 value may be used. The ISO8601 value will be converted to an epoch millisecond value.

cardRef

An array of payment card record uids.

Examples:

date

A epoch milliseconds value. Depending on method of creation, ie using a helper modules, an ISO8601 value may be used. The ISO8601 value will be converted to an epoch millisecond value.

email

A string value, normally for a user's email address. There is no validation of the value.

expirationDate

A epoch milliseconds value. Depending on method of creation, ie using a helper modules, an ISO8601 value may be used. The ISO8601 value will be converted to an epoch millisecond value.

fileRef

An array of file UIDs. When a file is attached to a record, that files UID will appear in this array.

host

A dictionary value containing:

• hostName - Hostname or IP

• port - Remote port

None of the keys are required.

Example:

{"hostName": "localhost", "port": "22"}

A dictionary value containing:

• publicKey - Public key

• privateKey - Private key

None of the keys are required.

Example:

{"publicKey": "PUBLIC KEY", "privateKey": "PRIVATE KEY"}

licenseNumber

A string value. There is no validation of the value.

login

A string value, normally the user's login. There is no validation of the value. Many Keeper related services will look for a field of this type for the login value.

multiline

A string value, normally for text that has line feed. There is no validation of the value.

name

A dictionary value containing:

• first - Person's first name

• middle - Person's middle name

• last - Person's last name

None of the keys are required.

Example:

{"first": "John", "middle": "Unknown", "last": "Smith"}

note

A string value that allow for multiline. The value is masked. There is no validation of the value.

otp

One time password URL for TOTP.

oneTimeCode

One time code URL for TOTP.

password

A string value. There is no validation of the value. Many Keeper related services will look for a field of this type for the password value.

paymentCard

A dictionary value containing:

• cardNumber - A payment card number

• cardExpirationDate - MM/YYYY expiration.

• cardSecurityCode - The security code

Example:

{"cardNumber": "5555 5555 5555 5555", "cardExpirationDate": "01/2023",
    "cardSecurityCode": "123"}

phone

An array of phone dictionaries. Each phone dictionary contains the following key/values:

• region - The country code number

• number - Normal phone number

• ext - Extension

• type - Mobile | Home | Work

None of the keys are required.

Example:

[
    {"region": "+1", "number": "555-555-5555", "ext": "1234", "type": "Work"},
    {"number": "555-555-6666", "type": "Mobile"}
]

pinCode

A string value. There is no validation of the value.

secret

A string value. This type of field is normally masked. There is no validation of the value.

securityQuestion

A dictionary value containing:

• question - The security question

• answer - The answer to the security question

Example:

{"question": "What Number?", "answer": "42"}

text

A string value. There is no validation of the value.

url

A string value, normally a web URL. There is no validation of the value.

Default Record Types

The following are the default record types provided by Keeper and the fields within the record type. Record types contain a collection of field types for the standard fields. Custom fields are not defined by a record type.

address (Address)

bankAccount (Bank Account)

bankCard (Payment Card)

birthCertificate (Birth Certificate)

• name - First Name, Middle Name, Last Name

• birthDate - Date of Birth

contact (Contact)

databaseCredentials (Database)

driverLicense (Driver's License)

encryptedNotes (Secure Note)

file (File Attachment)

This record is created when a file is attached to another record. The record UID will be attached to the record via the fieldRef field type.

Currently attaching files to records across all SDK is not finished. Content to be added.

healthInsurance (Health Insurance)

login (Login)

membership (Membership)

passport (Passport)

photo (Photo)

This record is created when a photo is attached to another record. The record UID will be attached to the record via the fieldRef field type.

Currently attaching photos to records across all SDK is not finished. Content to be added.

serverCredentials (Server)

softwareLicense (Software License)

ssnCard (Identity Card)

sshKeys (SSH Key)

Custom Record Types

Custom record types can be used with the Secrets Manager.

Keeper Commander can be used to get the schema for the custom record type.

My Vault> rti --format json -lr "My Custom" --output my_record_type.json
[
  {
    "recordTypeId": 18,
    "content": "{\"$id\":\"My Custom\",\"categories\":[\"login\"],
        \"description\":\"SSH key template\",\"fields\":
           [{\"$ref\":\"login\"},
            {\"$ref\":\"keyPair\"},
            {\"$ref\":\"password\",\"label\":\"passphrase\"},
            {\"$ref\":\"host\"},
            {\"$ref\":\"fileRef\"}]}"
  }
]

Based on the SDK being used, the JSON may be imported allowing the custom record to be used with any helper tools.