Data Models - API v7
(Versions 9+)
SUsageComment
Properties:
Comment: String - The usage comment text
SApiAttachment
Properties:
Id: GUID - Unique identifier for the attachment
CredentialObjectId: GUID - ID of the associated credential
FileName: String - Name of the attached file
FileDataId: GUID - ID for the file data
FileSize: Long - Size of the file in bytes
SApiAttachmentCombinedInfo
Properties:
CommonInfo: SApiAttachmentListInfo - Common attachment information
Attachments: List<SApiAttachment> - List of attachments
SApiAttachmentListInfo
Properties:
CredentialId: GUID - ID of the credential
AttachmentsEnabled: Boolean - Whether attachments are enabled
SApiCombinedInfo
Properties:
Level: SApiLevel - Level information
SubLevels: List<SApiLevel> - List of sub-levels
FeatureInfo: SApiFeatureInfo - Feature information
CommonInfo: SApiCredentialListInfo - Common credential information
Credentials: List<SApiCredential> - List of credentials
SApiCombinedInfoWithPathInfo
Properties:
CombinedInfo: SApiCombinedInfo - Combined information
PathInfo: List<SApiPathInfoPart> - Path information parts
SApiCredential
Properties:
Id: GUID - Unique identifier
GroupId: GUID - Group identifier
Name: String - Credential name
UserFavourite: Boolean - Whether marked as favourite
Username: String - Username
Url: String - Associated URL
Notes: String - Notes
Tags: String - Tags
Path: String - Path
Expired: Boolean - Whether expired
Expires: DateTimeOffset? - Expiration date
HasPendingRequest: Boolean - Whether has pending request
Created: DateTimeOffset? - Creation date
ArchivedOnDate: DateTimeOffset? - Archive date
IsArchived: Boolean - Whether archived
IsEncrypted: Boolean - Whether encrypted
IsLocked: Boolean - Whether locked
CustomFields: Dictionary<String, String> - Custom fields
CanEdit: Boolean - Edit permission
CanMove: Boolean - Move permission
CanDelete: Boolean - Delete permission
CanArchive: Boolean - Archive permission
CanCopyUsername: Boolean - Copy username permission
CanCopyPassword: Boolean - Copy password permission
CanCopyTOTPCode: Boolean - Copy TOTP code permission
ViewHistory: Boolean - View history permission
CanViewProxy: Boolean - View proxy permission
CanEditProxy: Boolean - Edit proxy permission
CanUseProxy: Boolean - Use proxy permission
CanViewSecurity: Boolean - View security permission
CanModifySecurity: Boolean - Modify security permission
CanModifyNotification: Boolean - Modify notification permission
CanModifyPasswordAutoChange: Boolean - Modify password auto-change permission
CanModifyCommentSettings: Boolean - Modify comment settings permission
CanDuplicate: Boolean - Duplicate permission
CanRestore: Boolean - Restore permission
CanRotateAndSync: Boolean - Rotate and sync permission
CanRequestAccess: Boolean - Request access permission
AskForCommentOnViewPassword: Boolean - Require comment on view password
AskForCommentOnSecurityDialog: Boolean - Require comment on security dialog
AskForCommentOnNotificationsDialog: Boolean - Require comment on notifications dialog
AskForCommentOnProxyDialog: Boolean - Require comment on proxy dialog
AskForCommentOnReqCommDialog: Boolean - Require comment on required comment dialog
AskForCommentOnPasswordAutoChangeDialog: Boolean - Require comment on password auto-change dialog
AskForCommentOnModifyEntries: Boolean - Require comment on modify entries
AskForCommentOnMoveEntries: Boolean - Require comment on move entries
AskForCommentOnApprovalDelete: Boolean - Require comment on approval delete
SApiCredentialDetail
Properties:
Id: GUID - Unique identifier
CredentialGroupId: GUID - Credential group ID
Name: String - Name
EncryptionEnabled: Boolean - Whether encryption is enabled
EncryptByDefault: Boolean - Whether to encrypt by default
UserFavourite: Boolean - Whether marked as favourite
EnableFavourites: Boolean - Whether favourites are enabled
Username: String - Username
Url: String - URL
Notes: String - Notes
Tags: String - Tags
ReadOnly: Boolean - Whether read-only
Password: String - Password
AccessDenied: Boolean - Whether access is denied
UserCanSave: Boolean - Whether user can save
ShouldExpire: Boolean - Whether should expire
Expires: DateTime? - Expiration date
IsEncrypted: Boolean - Whether encrypted
CommentRequired: Boolean - Whether comment is required
Comment: String - Comment
TOTPIssuer: String - TOTP issuer
TOTPSecret: String - TOTP secret
TOTPDigits: Int - TOTP digits
TOTPPeriod: Int - TOTP period
CustomUserFields: List<SApiCustomUserField> - Custom user fields
CustomApplicationFields: List<SApiCustomApplicationField> - Custom application fields
IsArchived: Boolean - Whether archived
CanModifyPasswordAutoChangeSettings: Boolean - Whether can modify password auto-change settings
HasExternalCredential: Boolean - Whether has external credential
IsScheduled: Boolean - Whether scheduled
LastSync: String - Last sync time
NextSync: String - Next sync time
AttachmentEnabled: Boolean - Whether attachments are enabled
CanViewTOTP: Boolean - Whether can view TOTP
CanEditTOTP: Boolean - Whether can edit TOTP
IsLocked: Boolean - Whether locked
PasswordProfiles: List<SApiPasswordProfile> - Password profiles
HasEditPasswordProfilesPermission: Boolean - Whether has edit password profiles permission
HasModifyEntriesAccess: Boolean - Whether has modify entries access
SApiCredentialDetailOrError
Properties:
HasPasswordError: Boolean - Whether has password error
ErrorMessage: String - Error message
ErrorDetails: String - Error details
CredentialDetail: SApiCredentialDetail - Credential detail
SApiCredentialListInfo
Properties:
CredentialGroupId: GUID - Credential group ID
CredentialGroupName: String - Credential group name
ParentId: GUID - Parent ID
CustomFields: String[] - Custom fields
EnableFavourites: Boolean - Whether favourites are enabled
EnableArchive: Boolean - Whether archive is enabled
ClickableLinks: Boolean? - Whether links are clickable
WarnLinks: Boolean? - Whether to warn about links
HasPendingRequest: Boolean - Whether has pending request
HasAddEntriesAccess: Boolean - Whether has add entries access
HasAddFoldersAccess: Boolean - Whether has add folders access
HasEditPermissions: Boolean - Whether has edit permissions
HasMovePermissions: Boolean - Whether has move permissions
HasDeletePermissions: Boolean - Whether has delete permissions
HasArchivePermissions: Boolean - Whether has archive permissions
HasDuplicatePermissions: Boolean - Whether has duplicate permissions
HasProxyPermissions: Boolean - Whether has proxy permissions
HasSecurityPermissions: Boolean - Whether has security permissions
HasNotificationPermissions: Boolean - Whether has notification permissions
HasPasswordAutoChangePermissions: Boolean - Whether has password auto-change permissions
HasRequireCommentPermissions: Boolean - Whether has require comment permissions
HasRestorePermissions: Boolean - Whether has restore permissions
HasRequestAccessPermissions: Boolean - Whether has request access permissions
HasModifyEntriesAccess: Boolean - Whether has modify entries access
HasViewEntryContentsAccess: Boolean - Whether has view entry contents access
AskForCommentOnSecurityDialog: Boolean - Require comment on security dialog
AskForCommentOnNotificationsDialog: Boolean - Require comment on notifications dialog
AskForCommentOnPasswordAutoChangeDialog: Boolean - Require comment on password auto-change dialog
AskForCommentOnProxyDialog: Boolean - Require comment on proxy dialog
AskForCommentOnReqCommDialog: Boolean - Require comment on required comment dialog
AskForCommentOnModifyEntries: Boolean - Require comment on modify entries
AskForCommentOnMoveEntries: Boolean - Require comment on move entries
AskForCommentOnMoveFolders: Boolean - Require comment on move folders
AskForCommentOnModifyFolders: Boolean - Require comment on modify folders
AskForCommentOnApprovalDelete: Boolean - Require comment on approval delete
AskForCommentOnViewOffline: Boolean - Require comment on view offline
AskForCommentOnViewPassword: Boolean - Require comment on view password
ArchiveFolderId: GUID? - Archive folder ID
ArchivedFromGroup: Boolean - Whether archived from group
SApiCustomApplicationField
Properties:
FieldId: GUID - Field ID
Key: String - Field key
Value: String - Field value
SApiCustomUserField
Properties:
FieldId: GUID - Field ID
Key: String - Field key
Value: String - Field value
SApiFeatureInfo
Properties:
EmailNotifications: Boolean - Whether email notifications are enabled
RequireComments: Boolean - Whether comments are required
PasswordAutoChanger: Boolean - Whether password auto-changer is enabled
HasArchive: Boolean - Whether archive is available
RequestApproval: Boolean - Whether request approval is enabled
HasProxy: Boolean - Whether proxy is available
SApiLevel
Properties:
Id: GUID - Unique identifier
Name: String - Level name
Blocked: Boolean - Whether blocked
IsRoot: Boolean - Whether is root
HasChildren: Boolean - Whether has children
IsArchive: Boolean - Whether is archive
IsExpanded: Boolean - Whether is expanded
SApiPasswordProfile
Properties:
Id: GUID - Unique identifier
Name: String - Profile name
SApiPathInfoPart
Properties:
Id: GUID - Unique identifier
Name: String - Path part name
SApiTotp
Properties:
Issuer: String - TOTP issuer
Secret: String - TOTP secret
Digits: Int - Number of digits
Period: Int - Time period
SUserInfoExtended
Properties:
Id: GUID - User ID
Username: String - Username
DirectoryQualifiedUsername: String - Directory qualified username
DisplayName: String - Display name
Email: String - Email address
Status: String - User status
Roles: String - User roles
Policy: String - User policy