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.