Table of Contents

Class AdminExternalAuthenticationProviderOptions

Namespace
Kentico.Membership
Assembly
Kentico.Membership.dll

Represents the authentication options for an external authentication provider for administration.

public sealed class AdminExternalAuthenticationProviderOptions
Inheritance
object
AdminExternalAuthenticationProviderOptions
Extension Methods

Properties

AuthenticateScheme

The authentication scheme for external authentication.

public string AuthenticateScheme { get; set; }

Property Value

string

EmailClaimName

Name of the claim containing the user email.

public string EmailClaimName { get; set; }

Property Value

string

Remarks

The default value is System.Security.Claims.ClaimTypes.Email.

FirstNameClaimName

Name of the claim containing the first name.

public string FirstNameClaimName { get; set; }

Property Value

string

Remarks

The default value is System.Security.Claims.ClaimTypes.GivenName.

LastNameClaimName

Name of the claim containing the last name.

public string LastNameClaimName { get; set; }

Property Value

string

Remarks

The default value is System.Security.Claims.ClaimTypes.Surname.

RoleClaimName

Name of the claim containing Kentico role identifier.

public string RoleClaimName { get; set; }

Property Value

string

Remarks

The default value is System.Security.Claims.ClaimTypes.Role.

SignInScheme

The sign-in scheme for external authentication.

public string SignInScheme { get; set; }

Property Value

string

Remarks

The default value is EXTERNAL_SCHEME.

UserNameClaimName

Name of the claim containing the username.

public string UserNameClaimName { get; set; }

Property Value

string

Remarks

The default value is DEFAULT_USERNAME_CLAIM_NAME.

UserSynchronizationFrequency

The frequency at which role synchronization should be performed.

public UserSynchronizationFrequency UserSynchronizationFrequency { get; set; }

Property Value

UserSynchronizationFrequency

Remarks

Default value is Never.

Methods

Validate(string, AdminExternalAuthenticationProviderOptions)

Validates a specific named options instance (or all when name is null).

public ValidateOptionsResult Validate(string name, AdminExternalAuthenticationProviderOptions options)

Parameters

name string

The name of the options instance being validated.

options AdminExternalAuthenticationProviderOptions

The options instance.

Returns

ValidateOptionsResult

The Microsoft.Extensions.Options.ValidateOptionsResult result.