usr: HTTP x-msg-usr entity-header
Set or return the user properties.
Type | Description |
---|---|
HTTP header name | x-msg-usr |
HTTP header type | Entity-header |
Valid in HTTP request message | POST, x-msg-require-headers |
Allowed values | See Syntax ; for example,
x-msg-usr: myProp1;5;i1, x-msg-usr: myProp2;"My String";string |
Default value | Not applicable |
Description
- When set on an HTTP POST request, set the request message user properties.
- On an HTTP GET or DELETE request, the x-msg-usr header is ignored.
- Specified in x-msg-require-headers, sets x-msg-usr in the HTTP response message to user properties of a message.
- Multiple properties can be set on a message. Specify multiple comma-separated properties in a single x-msg-usr header, or by using two or more separate instances of the x-msg-usr header.
- We can request a specific property to be returned in the response to a GET or DELETE request. Specify the name of the property in the x-msg-require-headers header of the request, using the prefix usr-. For example,
x-msg-require-headers: usr-myProp1
- To request that all user properties are returned in a response, use the ALL-USR constant. For example,
x-msg-require-headers: ALL-USR
Syntax
usr-property-valueproperty-nameusr-valueusr-typebooleani1i2i4i8r4r8qstring