2.2.2 Common URI Parameters

Office

 The following URI parameters MUST be included with all WOPI requests.

URI Parameter

Description

<token>

A string used by the WOPI server to determine the identity and permissions of the issuer of the WOPI request. The token is generated by the WOPI server and learned by the WOPI client before the first WOPI request. The WOPI server passes the token to the WOPI client in the initiating request described in section 3.1.5.1.1.2.3.3.

The WOPI client requires no understanding of the format or content of the token.

The token SHOULD expire after a length of time deemed reasonable by the implementer of the WOPI server.

The token SHOULD only provide access to resources associated with the WOPI request. That is, the token SHOULD be scoped to a specific user and set of resources. 

<id>

The id represents the file or folder being operated on by the WOPI client. A WOPI server MUST issue a unique id for any resource that a WOPI client operates on.

The <token> and <id> parameters are a core part of all WOPI requests. The URI syntax for using these parameters is described first in the CheckFileInfo operation (see section 3.3.5.1.1). The WOPI server provides both <token> and <id> through the urlsrc parameter, as described in the st_wopi-url-source simple type (see section 3.1.5.1.1.2.3.3).

The following URI parameters can be included with all WOPI requests.

URI Parameter

Description

<sc>

The sc is a string that the WOPI server MAY include with a WOPI request. The WOPI client MAY in turn return the value of sc as the value of the X-WOPI-SessionContext HTTP header when making the CheckFileInfo (section 3.3.5.1.1) and CheckFolderInfo (section 3.3.5.2.1) WOPI requests.

Show: