VerifyEntitlementTokenRequest.EntitlementToken property

Gets or sets the app license token being submitted to the Office Store verification web service for validation.

Namespace:  VerificationSvc
Assembly:  SP15MrefVerificationSvc (in SP15MrefVerificationSvc.dll)

Syntax

'Declaration
Public Property EntitlementToken As String
    Get
    Set
'Usage
Dim instance As VerifyEntitlementTokenRequest
Dim value As String

value = instance.EntitlementToken

instance.EntitlementToken = value
public string EntitlementToken { get; set; }

Property value

Type: System.String
A literal string representing the app license token being submitted.

Remarks

The app license token must be formatted according to the App License Schema.

Important

While the app license token is structured as an XML fragment, for purposes of validation the Office Store verification web service treats the token as a literal string. The Office Store verification web service compares the contents of the <t> element to the value of the <d> element, which is an encrypted signature derived from the literal string contained in the <t> element. Any reformatting of the license token, such as adding white space, tabs, line breaks, etc., will change the literal value of the <t> element and therefore cause the license verification check to fail. Developers are advised not to parse or otherwise manipulate the app license token string before passing it to the Office Store verification web service for verification.

When you submit a test app license token to the Office Store verification web service, the service does not perform that validation check of comparing the encrypted signature in the <d> element to the string contained in the <t> element. This enables developers to create their own test app license tokens for testing purposes without worrying about formatting, or generating the encryption signature for the <d> element.

See also

Reference

VerifyEntitlementTokenRequest class

VerifyEntitlementTokenRequest members

VerificationSvc namespace

VerificationServiceClient.VerifyEntitlementToken

VerifyEntitlementTokenResponse

Other resources

License your apps for Office and SharePoint

How to: Add license checks to your apps for Office

How to: Add license checks to your app for SharePoint

Best practices and design patterns for app license checking

App License Schema