VES Manifest
VES Manifest is a JSON resource that advertises VES integration capabilities pertaining to a specific HTTPS origin. VES Manifest should be returned in response to HTTPS GET request to "/ves.json" URI on a particular domain. The response content type should be "application/json".
schema String Must be VES-1.0
apps Array(object) 0 or more VES apps handled by the web domain.
href String Either an absolute URL within the site domain, or a relative URL starting with /. Identifies the location of the VES app root within the domain. If multiple Apps are supplied in the manifest, each must have a distinct href.
app String An optional arbitrary string that identifies the type of the VES App. Ignored by vesvault.com, can be used for discovery by third parties.
domain String The VES domain this app operates under, given as a registered VES domain tag. Required for an app that is managed and billed through VES Enterprise: it binds the app (located by its href) to the VES domain that the operating company is billed for. Must match a VES domain registered with vesvault.com.
name String A human readable app name. Displayed by vesvault.com in the authorization flow.
icon String A square icon URL, 128x128 PNG or SVG recommended. Displayed by vesvault.com in the authorization flow.
banner String An optional wide banner URL, 128px height PNG or SVG recommended. Displayed by vesvault.com in the authorization flow. If banner is not supplied, icon will be used instead.
login_message String An optional custom message for vesvault.com Create/Connect Account page.
login_explain String An optional custom prompt for vesvault.com Create/Connect Account page.
provider String An optional provider or vendor name. Displayed by vesvault.com in the authorization flow.
description String An optional human readable description of the app. Displayed by vesvault.com in the authorization flow.
action String An optional label that customizes the wording of the action being authorized. Displayed by vesvault.com in the authorization flow.
verb String An optional verb that customizes the wording of the action being authorized. Displayed by vesvault.com in the authorization flow.
signup_prompt String An optional custom prompt shown on the vesvault.com account sign-up screen.
sandbox_message String An optional message shown by vesvault.com when the app connects in sandbox mode. Limited html tags are permitted.
links Array(object) Optional related links for the app, displayed by vesvault.com in the authorization flow.
rel String The link relation. home is rendered as the app home link on the icon and banner.
href String The link URL.
redundancy object An optional custom 3rd party app info for vesvault.com Key Redundancy page.
title String The title of the 3rd party redundancy section.
description String 3rd party redundancy description. Limited html tags are permitted.
risk String 3rd party redundancy risk info. Limited html tags are permitted.
enable String 3rd party redundancy enabling instructions. Limited html tags are permitted.
enterprises Array(object) 0 or more VES Enterprise companies operated from this origin. Consumed by VES Enterprise on vesvault.com to bind a company to the VES app it manages, and to bill the company for that app's VES domain usage.
tag String Required. A stable identifier for the company, unique within this manifest. Together with the origin it identifies the VES Enterprise record.
owner String Required. Email address of the VES account that owns the company. To import the company into VES Enterprise, the signed-in user's account email must match this value.
appUrl String Required. URL of the VES app this company manages. vesvault.com resolves it against the apps[] of the app origin's manifest (longest matching href), and uses the matched app's domain as the company's billable VES domain.
name String An optional human readable company name, displayed by vesvault.com.
description String An optional company description, displayed by vesvault.com.
icon String An optional square company icon URL, displayed by vesvault.com.
href String An optional link to the company or app page, displayed by vesvault.com. If its host matches the origin, only the path is shown.
servers Array(object) 0 or more VES aware servers hosted by the domain.
server String An IANA registered service name, or a custom name understandable by the involved parties.
host String Host name
proto String tcp | udp
port Int TCP/UDP port number