ICollabSessionOptions Interface

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ICollabSessionOptions

Properties

Property	Alerts	Modifiers	Type	Description
forceAccessTokenViaAuthorizationHeader	Deprecated, Alpha	optional	boolean	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.
unauthenticatedUserDisplayName	Deprecated, Alpha	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

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.

This API is deprecated and will be removed in a future release.

Due to security reasons we will be passing the token via Authorization header only.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

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.

This API is deprecated and will be removed in a future release.

starting in 2.0-RC3. No longer needed.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

unauthenticatedUserDisplayName?: string;

Type: string