IRPCClientScript.SetVaultApplicationLicense

View as Markdown

Vault API / standard write session idempotent

Installs or removes the license of a vault application.

Service	Client scripts and UI extension applications `MFiles.IRPCClientScript`
gRPC method	`/MFiles.IRPCClientScript/SetVaultApplicationLicense`
HTTP (mf-http-grpc)	`POST /grpc/v1/set-vault-application-license`
Request	`SetVaultApplicationLicenseRequest`
Response	`SetVaultApplicationLicenseResponse`
Book and level	Vault API, standard
Kind	write
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires the vault right change_metadata_structure.
An empty license removes the license. A license that the application reports as malformed is rejected.
The new license is passed to the running application. Check the result with GetVaultApplicationLicenseStatus.

Request: SetVaultApplicationLicenseRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`script_application`	`string`	The GUID of the application.
`license`	`string`	The content of the license file; empty to remove the license.

Response: SetVaultApplicationLicenseResponse

No fields.

GetVaultApplicationLicenseStatus -- Gets the license status of a vault application, or checks a license before installing it.