PutUserInfo

The PutUserInfo operation stores basic user information on the host.

POST /wopi/files/(file_id)

The PutUserInfo operation stores some basic user information on the host. When a host receives this request, they must store the UserInfo string, which is contained in the body of the request. The UserInfo string should be associated with a particular user, and should be passed back to the WOPI client in subsequent CheckFileInfo responses in the UserInfo property.

The UserInfo string is provided in the body of the request, and has a maximum size of 1024 ASCII characters.

WOPI clients only call this WOPI operation if the host sets the SupportsUserInfo property to true in the CheckFileInfo response.

Parameters

• file_id (string) – A string that specifies a file ID of a file managed by host. This string must be URL safe.

Query parameters

• access_token (string) – An access token that the host uses to determine whether the request is authorized.

Request headers

• X-WOPI-Override – The string PUT_USER_INFO. This header is required.

Body

The request body must be the full UserInfo string.

Status codes

• 200 OK – Success.

• 401 Unauthorized – Invalid access token.

• 404 Not Found – Resource not found or user unauthorized.

• 500 Internal Server Error – Server error.

• 501 Not Implemented – Operation not supported.