ICollabSessionOptions Interface
Signature
export interface ICollabSessionOptions
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| forceAccessTokenViaAuthorizationHeader | Deprecated |
optional |
boolean | |
| unauthenticatedUserDisplayName | optional |
string | Value indicating the display name for session that admits unauthenticated user. This name will be used in attribution associated with edits made by such user. |
Property Details
forceAccessTokenViaAuthorizationHeader
This API is deprecated and will be removed in a future release.
- Due to security reasons we will passing the token via Authorization header only. Value indicating session preference to always pass access token via Authorization header. Default behavior is to pass access token via query parameter unless overall href string length exceeds 2048 characters. Using query param is performance optimization which results in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to validate CORS. However, not all ODSP implementations understand this optimization. For instance, auth layer on Converged stack will fail request with access token passed via query param.
Signature
forceAccessTokenViaAuthorizationHeader?: boolean;
Type: boolean
unauthenticatedUserDisplayName
Value indicating the display name for session that admits unauthenticated user. This name will be used in attribution associated with edits made by such user.
Signature
unauthenticatedUserDisplayName?: string;
Type: string