Skip to main content

Principal

Description

The Valkyr Principal. Represents a user, service, or agent in the system with preferences and privileges.

Properties

NameTypeDescriptionNotes
firstNameStringfirst name of user (encrypted)[optional]
middleNameStringmiddle name of user[optional]
lastNameStringlast name of user (encrypted)[optional]
usernameStringYour account user name
passwordStringYour account password
fingerprintStringEncrypted identity (Facial Recognition, Fingerprint Scanner, etc.)[optional] [readonly]
federalIdentificationStringSSN or a 10 digit federal government ID (encrypted)[optional]
residenceCountryStringCountry of residence 3-character code[optional]
stateIdentificationStringDriver's License or a 10 digit state government ID[optional]
residenceStateStringState of residence 2-character code (USA)[optional]
emailStringThe main email address
phoneStringThe main phone number[optional]
socialStringThe username for your primary social account (if any)[optional]
bioStringMore in-depth information about you and your account[optional]
notesString[optional]
avatarUrlStringURL for the user avatar image[optional]
organizationOrganization[optional]
addressesList<Address>[optional]
acceptedCookiesBooleanWhether the user accepted the use of cookies[optional]
acceptedTosBooleanWhether the user accepted the terms of service[optional]
enabledBooleanSpring Security User field whether the user is enabled[optional]
credentialNonExpiredBooleanSpring Security User field whether the user's login credentials have expired[optional]
accountEnabledBooleanSpring Security User field whether the user account is enabled[optional]
accountNonLockedBooleanSpring Security User field whether the user account is locked[optional]
accountNonExpiredBooleanSpring Security User field whether the user account has expired[optional]
roleListList<Role>the roles the the Principal is a member of
authorityListList<Authority>the granted authorities (or null if the granted authority cannot be expressed as a String with sufficient precision).
userPreferencesList<UserPreference>the granted authorities (or null if the granted authority cannot be expressed as a String with sufficient precision).[optional]
idUUIDUnique identifier for object in the system[optional] [readonly]
ownerIdUUIDUUID of owner of the object in the system[optional] [readonly]
createdDateOffsetDateTimeDate of object creation[optional] [readonly]
keyHashStringData, including hash of the key(s) used to encrypt this record.[optional] [readonly]
lastAccessedByIdUUIDLast user to access object[optional] [readonly]
lastAccessedDateOffsetDateTimeTimestamp of last access of object[optional] [readonly]
lastModifiedByIdUUIDUnique identifier for user who last modifed the object in the system[optional] [readonly]
lastModifiedDateOffsetDateTimeDate of last object modification[optional] [readonly]

Implemented Interfaces

  • Serializable

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.1-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-12-03T11:13:18.492704-08:00[America/Los_Angeles]