Single Sign On Authentication Properties

The following properties are available for Single Sign On Authentication objects, grouped by the categories shown in the authentication service editors.

Behavior

Property Type Default Description

AllowSharingViewsWithEveryone

bool

true

Controls whether the authenticated user is allowed to share saved views with everyone.

By default, the user is allowed to share saved views with everyone. The property is typically set to False when the RolesToShareViewsWith and/or UsersToShareViewsWith restrict the roles and/or users with whom the user is allowed to share saved views.

AllowStartupForUserAssignedNoRoles

bool

true

Controls whether the application starts up when the user is not assigned any roles.

AllowedAttributes

string[]

An optional list of allowed attribute names to include as roles (i.e., memberof, team, type).

AttributeToRoleMappings

List<SerializablePair<string,string>>

An optional set of mappings to translate attribute values to roles.

MessageCaptionForUserAssignedNoRoles

string

When the user is not assigned any roles and AllowStartupForUserAssignedNoRoles is False, a MessageBox is optionally displayed. If MessageTextForUserAssignedNoRoles is non-empty, the MessageCaptionForUserAssignedNoRoles is used as the MessageBox caption.

MessageTextForUserAssignedNoRoles

string

When the user is not assigned any roles and AllowStartupForUserAssignedNoRoles is False, a MessageBox is optionally displayed. If MessageTextForUserAssignedNoRoles is non-empty, a MessageBox is displayed and the MessageTextForUserAssignedNoRoles is used as the MessageBox text.

RolesRequiredForStartup

RolesRequiredForStartupFilter

Controls which roles are required to start the application.

AnyRole - allows any user with an assigned role to start the application.

AnySpecificRole - allows any user with an assigned role that matches any of the specified roles to start the application.

AllSpecificRoles - allows any user who matches all of the specified roles to start the application.

RolesRequiredForStartup_SpecificRoles

ViewAccessInfoList

Identifies the specific role requirements to start the application when the RolesRequiredForStartup property is set to AnySpecificRole or AllSpecificRoles.

View Sharing

Property Type Default Description

RolesToShareViewsWith

RolesToShareViewsWithFilter

RolesToShareViewsWithFilter.None

Controls which roles (i.e. Essbase groups) the authenticated user is allowed to share views with.

None - No sharing with roles is allowed.

SameRoleAsUser - Sharing is allowed with the roles that the authenticated user is assigned to.

AllRoles - Sharing is allowed with all roles.

SpecificRoles - Sharing is allowed with the roles identified by the RolesToShareViewsWith_SpecificRoles property.

RolesToShareViewsWith_SpecificRoles

ViewAccessInfoList

Identifies the specific role(s) the authenticated user is allowed to share views with when the RolesToShareViewsWith is set to SpecificRoles.