Interface ITenantLoginOption

Describes the login option which can be requested by any application on startup without login. It describes which kind of login mechanism (e.g. Basic, SSO or OAI-Secure) is supported by the current Platform.

Hierarchy

  • ITenantLoginOption

Properties

authenticationRestrictions? buttonName? enforceStrength? grantType? greenMinLength? id? initRequest? loginRedirectDomain? providerName? self? sessionConfiguration? strengthValidity? tfaStrategy? type? userManagementSource visibleOnLoginPage?

Properties

Optional authenticationRestrictions

authenticationRestrictions?: IAuthenticationRestrictions

Basic authentication restrictions.

Optional buttonName

buttonName?: string

The label which is shown on the login button

Optional enforceStrength

enforceStrength?: boolean

Determines if password strength is enforced on system level

Optional grantType

grantType?: GrantType

Grant type

Optional greenMinLength

greenMinLength?: number

Minimum length of a password to be considered as a “green” strong one

Optional id

id?: string

Identifies the login option

Optional initRequest

initRequest?: string

The request which is used to initialize an oauth flow

Optional loginRedirectDomain

loginRedirectDomain?: string

Tenant correct domain for OAI-Secure login option. UI will redirect to this domain if OAI-Secure is set as preferred login mode and domain in browser is wrong.

Optional providerName

providerName?: string

Organizations name which provides login option

Optional self

self?: string

Link to the resource

Optional sessionConfiguration

sessionConfiguration?: ISessionConfiguration

Configuration for OAI-Secure sessions.

Optional strengthValidity

strengthValidity?: boolean

Determines if password strength is enforced on tenant level

Optional tfaStrategy

tfaStrategy?: TfaStrategy

The strategy for Two Factor Authentication

Optional type

type?: TenantLoginOptionType

Login option type

userManagementSource

userManagementSource: UserManagementSource

The origin of the users REMOTE or INTERNAL

Optional visibleOnLoginPage

visibleOnLoginPage?: boolean

Indicates whether the login option should be visible on the login page of UI applications. If set to true for more than one login option, then the preferred one will be selected according to priority:

  1. OAI-Secure: authentication information is stored in a HttpOnly cookie
  2. Basic Auth: authentication information is stored in a session storage
  3. SSO redirect: allows a user to login with a single 3rd-party authorization server using the OAuth2 protocol. If no login option has visibleOnLoginPage set to true, the preferred login option will be Basic Auth.

Settings

Member Visibility

Theme