Field/Record Types

A reference of field and record types available to secrets manager.

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.

Use the proper formatting for the field type. By default, the SDK will not valid check most fields. Best practices would to properly format the data for the field. Other products, offered by Keeper, will retrieve data from record based on the field type.

accountNumber

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

address

A dictionary value containing:

None of the keys are required.

Example:

{"street1": "100 Main Street", "city": "Town", "state": "RI", "zip": "55555",
    "country": "US"}

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:

{"accountType": "Checking", "routingNumber": "123456", "accountNumber": "55555555"}

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:

["OlLZ6JLjnyMOS3CiIPHBjw", "XJ2VISBJ3JAeCwU_YGAXYg"]

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.

All the default record types include the fileRef field. This field contains files UID and photos UID attached to a record. Check the documentation for the SDK being used on how to download a file. Currently file attachment via the SDK is limited.

address (Address)

Field TypeUI Fields

address

Street Address Line 1 Street Address Line 2 City State/Province Zip/Postal Code Country

bankAccount (Bank Account)

Field TypeUI Fields

bankAccount

Account Type Other Type Account Number Routing Number

name

First Name Middle Name Last Name

login

Login

password

Password

url

Website Address

cardRef (value is bankCard record uid)

Payment Card

bankCard (Payment Card)

Field TypeUI Fields

paymentCard

Card Number Expiration Month Expiration Year Security Code

text

Cardholder Name

pinCode

Pin Code

addressRef (value is address record uid)

Address (see address record type for UI)

birthCertificate (Birth Certificate)

  • name - First Name, Middle Name, Last Name

  • birthDate - Date of Birth

Field TypeUI Fields

name

First Name Middle Name Last Name

birthDate

Date of Birth

contact (Contact)

Field TypeUI Fields

name

First Name Middle Name Last Name

text

Company

email

Email

phone

Country Phone Number Ext. Type

addressRef (value is address record uid)

Address (see address record type for UI)

databaseCredentials (Database)

Field TypeUI Fields

text

Type

host

Hostname or IP Address Port

login

Login

password

Password

driverLicense (Driver's License)

Field TypeUI Fields

accountNumber

Driver's License Number

name

First Name Middle Name Last Name

birthDate

Date of Birth

addressRef (value is address record uid)

Address (see address record type for UI)

expirationDate

Expiration Date

encryptedNotes (Secure Note)

Field TypeUI Fields

note

Secured Note

date

Date

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)

accountNumber

Account Number

name

First Name Middle Name Last Name

login

Login

password

Password

url

Website Address

login (Login)

Field TypeUI Fields

login

Login

password

Password

url

Website Address

membership (Membership)

Field TypeUI Fields

accountNumber

Account Number

name

First Name Middle Name Last Name

password

Password

passport (Passport)

Field TypeUI Fields

accountNumber

Passport Number

name

First Name Middle Name Last Name

birthDate

Date of Birth

addressRef (value is address record uid)

Address (see address record type for UI

expirationDate

Expiration Date

date

Date Issued

password

Password

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)

Field TypeUI Fields

host

Hostname or IP Address Port

login

Login

password

Password

softwareLicense (Software License)

Field TypeUI Fields

licenseNumber

Software License Key

expirationDate

Expiration Date

date

Date Active

ssnCard (Identity Card)

Field TypeUI Fields

accountNumber

Identity Number

name

First Name Middle Name Last Name

sshKeys (SSH Key)

Field TypeUI Fields

login

Login

keyPair

Public Key Private Key

password

Passphrase

host

Hostname or IP Address Port

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.

Last updated