Service Models

Users prefer Pleasant Password Server with a KeePass client!

Contents

• Entry
• Folder
• Comment Wrapper
• Comment Prompt
• Tag
• Attachment
• Offline Package
• About Server
• Password Strength
• Search Results
• Credential Search Result
• Credential Group Search Result
• Client Config

API Version 5 (Server Versions 7.9.7+)

Endpoints: https://[domain]:[port]/api/v5/rest/entries/{id}

• Fields
  
  • Mandatory
    
    • Id : GUID (Can be omitted when creating a new credential with POST as of version 7.9.18)
    • GroupId : GUID
  • Optional
    
    • Name : String
    • Password : String
    • Url : String
    • Notes : String
    • Expires : DateTimeOffset
    • CustomUserFields : Dictionary<String, String>
    • CustomApplicationFields : Dictonary<String, String>
    • Tags : List<STag>
  • Read-only
    
    • Created : DateTimeOffset
    • Modified : DateTimeOffset
    • HasModifiyEntriesAccess : Boolean
    • HasViewEntryContentsAccess : Boolean
    • CommentPrompts : SCommentPrompt

This object can be partially updated. To accomplish this, make a PATCH request with a JSON Object containing only the non read-only fields that you would like to update.

 Note about CustomApplicationFields:

• These are fields used by the KeePass Client.
  It is best to pass these back with the values they come with.

  Possible Keys:

  IconId
  CustomIconId
  ForegroundColor
  BackgroundColor
  OverrideUrl
  AutoTypeEnabled
  AutoTypeDefaultSequence
  AutoType: + target window name

Example Entry (JSON) 

CredentialGroup (Folder)

API Version 5 (Server Versions 7.9.7+)

Endpoints: https://[domain]:[port]/api/v5/rest/folders/{id}

• Fields
  
  • Mandatory
    
    • Id : GUID
    • Name : String
    • Password : String
    • GroupId : GUID
  • Optional
    
    • Url : String
    • Notes : String
    • Expires : DateTimeOffset
    • CustomUserFields : Dictionary<String, String>
    • CustomApplicationFields : Dictonary<String, String>
    • Tags : List<STag>
  • Read-only
    
    • Children : List<CredentialGroup>
    • Credentials : List<Credential>
    • Created : DateTimeOffset
    • Modified : DateTimeOffset
    • HasModifiyEntriesAccess : Boolean
    • HasViewEntryContentsAccess : Boolean
    • CommentPrompts : SCommentPrompt

This object can be partially updated. To accomplish this, make a PATCH request with a JSON Object containing only the non read-only fields that you would like to update.

Example CredentialGroup (JSON)

ActionCommentRequiredWrapper<T>

API Version 5 (Server Versions 7.9.7+)

This wrapper is used with entries or folders when a comment is required.

Fields

• Mandatory
  
  • Item : Credential -or- CredentialGroup
  • Comment : String

CommentPrompt

No specific endpoints, this object is used by entry and folder to mark if usage comments are required in certain situations. The field name refers to the action that is being performed while the value should be true if a usage comment is required to perform that action.

These objects are not required for Updates or Inserts of entries and folders.

• Fields
  
  • Read-only
    
    • AskForCommentOnViewPassword : Boolean
    • AskForCommentOnViewOffline : Boolean
    • AskForCommentOnModifyEntries : Boolean
    • AskForCommentOnMoveEntries : Boolean
    • AskForCommentOnMoveFolders : Boolean
    • AskForCommentOnModifyFolders : Boolean

Example CommentPrompt (JSON)

Tag

Used by entries and folders to hold Tags

• Fields
  • Read-only
    • Name : String

Example Tag (JSON)

Attachment

Used by entries and folders to hold file attachments.

• Fields
  
  • Mandatory
    
    • CredentialObjectId : GUID
    • FileName : String
    • FileData : Byte[]
  • Read-only
    
    • FileSize : Long

Example Attachment (JSON)

API Version 5 (Server Versions 7.9.7+

Endpoints: https://[domain]:[port]/api/v5/rest/offlinepackage

• Fields
  
  • Read-only
    
    • Root : CredentialGroup
    • Attachment : List<Attachment>
    • Expiry : DatetimeOffset

Example Entry (JSON)

AboutServer

Endpoints: https://[domain]:[port]/api/{version}/rest/about

• Fields
  
  • Read-only
    
    • ServerVersion : String
    • NetVersion : String
    • OsVersion : String
    • PortSettings : String
    • DnsInformation : String
    • Ping : String

Notes:

1. For details on NetVersion and OsVersion, see MSDN and MSDN respectively.
2. Ping is not currently not implemented (as of version 7.0.10.0)

Example AboutServer (JSON)

PasswordStrength

Endpoints: https://[domain]:[port]/api/{version}/rest/passwordstrength

POST requests ONLY. Request body should contain a JSON or XML object with a single field 'Password' with the password that is to be mesaured. For example:

• Fields
  • Read-only
    
    • NumericalStrength : Decimal
    • DescriptiveStrength : String

Example PasswordStrength (JSON)

SearchResults

Endpoints: https://[domain]:[port]/api/{version}/rest/search

POST requests ONLY. Request body should contain a JSON or XML object with a single field 'Search' with the string that is to be searched for. For example:

Response

• Fields
  • Read-only
    
    • Credentials : List<CredentialSearchResult>
    • Groups : List<CredentialGroupSearchResult>

CredentialSearchResult

One of the two types returned in a SearchResults object. 

• Fields
  • Read-only
    
    • Id : GUID
    • Name : String
    • Username : String
    • Url : String
    • Notes : String
    • GroupId : GUID
    • Path : GUID

CredentialGroupSearchResult

The other type returned in a SearchResults object. 

• Fields
  • Read-only
    
    • Id : GUID
    • Name : String
    • FullPath : String

Example Search Objects (JSON)

{
    Name: "SampleConfig.config.xml"
    ConfigXml: "<Configuration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
		<Meta> 
			<TemplateGroupId />
			<PreferUserConfiguration>true</PreferUserConfiguration>     
			<OmitItemsWithDefaultValues>true</OmitItemsWithDefaultValues>
		</Meta> 
		<Application>
			<TemplateGroupId /> 
			<LastUsedFile> 
				<Path>Pleasant Password     Server</Path> 
				<CredProtMode>Obf</CredProtMode> 
				<CredSaveMode>NoSave</CredSaveMode>
			</LastUsedFile> 
			<MostRecentlyUsed> 
				<MaxItemCount>12</MaxItemCount>
				<Items />
			</MostRecentlyUsed>
			<WorkingDirectories />
			<Start>
				<CheckForUpdate>false</CheckForUpdate> 
			</Start> 
			<FileOpening /> 
			<FileClosing />     
			<TriggerSystem> 
				<Triggers /> 
			</TriggerSystem> 
		</Application>
		<Logging /> 
		<MainWindow> 
			<SplitterHorizontalFrac>0.828915656</SplitterHorizontalFrac>     <CloseButtonMinimizesWindow>true</CloseButtonMinimizesWindow>
			<MinimizeToTray>true</MinimizeToTray> 
			<ToolBar /> 
			<EntryView />
			<EntryListColumnDisplayOrder>0 1 2 3 4</EntryListColumnDisplayOrder>
		</MainWindow>
		<UI>
			<BannerStyle>WinVistaBlack</BannerStyle>
			<TrayIcon />
			<Hiding />
			<StandardFont>
				<Family>Microsoft Sans Serif</Family>
				<Size>8.25</Size>
				<GraphicsUnit>Point</GraphicsUnit>
				<Style>Regular</Style>
				<OverrideUIDefault>false</OverrideUIDefault>
			</StandardFont>
			<PasswordFont>
				<Family>Courier New</Family>
				<Size>8.25</Size>
				<GraphicsUnit>Point</GraphicsUnit>
				<Style>Regular</Style>
				<OverrideUIDefault>false</OverrideUIDefault>
			</PasswordFont>
			<DataEditorFont>
				<Family>Microsoft Sans Serif</Family>
				<Size>8.25</Size>
				<GraphicsUnit>Point</GraphicsUnit>
				<Style>Regular</Style>
				<OverrideUIDefault>false</OverrideUIDefault>
			</DataEditorFont>
			<UIFlags>0</UIFlags>
			<KeyCreationFlags>0</KeyCreationFlags>
			<KeyPromptFlags>0</KeyPromptFlags>
		</UI>
		<Security>
			<WorkspaceLocking>
				<LockAfterTime>900</LockAfterTime>
				<LockAfterGlobalTime>240</LockAfterGlobalTime>
			</WorkspaceLocking>
			<Policy />
			<MasterPassword>
				<MinimumLength>0</MinimumLength>
				<MinimumQuality>0</MinimumQuality>
			</MasterPassword>
			<ClipboardClearAfterSeconds>-1</ClipboardClearAfterSeconds>
		</Security>
		<Native />
		<PasswordGenerator>
			<AutoGeneratedPasswordsProfile>
				<GeneratorType>CharSet</GeneratorType>
				<Length>20</Length>
				<CharSetRanges>ULD_______</CharSetRanges>
			</AutoGeneratedPasswordsProfile>
			<LastUsedProfile>
				<Name>    (Custom)</Name>
				<GeneratorType>CharSet</GeneratorType>
				<Length>16    </Length>
				<CharSetRanges>ULD_______</CharSetRanges>
			</LastUsedProfile>
			<UserProfiles     />
		</PasswordGenerator>
		<Defaults>
			<OptionsTabIndex>0</OptionsTabIndex>
			<SearchParameters>
				<ComparisonMode>InvariantCultureIgnoreCase</ComparisonMode>
			</SearchParameters>
			<KeySources /> 
		</Defaults> 
		<Integration>
			<HotKeyGlobalAutoType>393281</HotKeyGlobalAutoType>
			<HotKeySelectedAutoType>0</HotKeySelectedAutoType>
			<HotKeyShowWindow>393291</HotKeyShowWindow>
			<HotKeyEntryMenu>0</HotKeyEntryMenu>
			<UrlSchemeOverrides>
				<BuiltInOverridesEnabled>1</BuiltInOverridesEnabled>
				<CustomOverrides />
			</UrlSchemeOverrides>
			<ProxyType>System</ProxyType>
		</Integration> 
	</Configuration>"
}