• management
• Management
• ConnectionOptionsAdfs

Interface ConnectionOptionsAdfs

Options for the 'adfs' connection

interface ConnectionOptionsAdfs {
adfs_server?: string;
domain_aliases?: ConnectionDomainAliases;
entityId?: string;
fedMetadataXml?: string;
icon_url?: string;
prev_thumbprints?: ConnectionThumbprints;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
should_trust_email_verified_connection?: Management.ConnectionShouldTrustEmailVerifiedConnectionEnum;
signInEndpoint?: string;
tenant_domain?: string;
thumbprints?: ConnectionThumbprints;
upstream_params?: ConnectionUpstreamParams;
user_id_attribute?: string;
non_persistent_attrs?: ConnectionNonPersistentAttrs;
key: string: any;
}

Hierarchy (View Summary)

• ConnectionOptionsCommon
  • ConnectionOptionsAdfs

Indexable

Accepts any additional properties

Index

Properties

adfs_server?domain_aliases?entityId?fedMetadataXml?icon_url?prev_thumbprints?set_user_root_attributes?should_trust_email_verified_connection?signInEndpoint?tenant_domain?thumbprints?upstream_params?user_id_attribute?non_persistent_attrs?

Properties

Optionaladfs_server

adfs_server?: string

ADFS federation metadata host or XML URL used to discover WS-Fed endpoints and certificates. Errors if adfs_server and fedMetadataXml are both absent.

Optionaldomain_aliases

domain_aliases?: ConnectionDomainAliases

OptionalentityId

entityId?: string

The entity identifier (Issuer) for the ADFS Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'.

OptionalfedMetadataXml

fedMetadataXml?: string

Optionalicon_url

icon_url?: string

Optionalprev_thumbprints

prev_thumbprints?: ConnectionThumbprints

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

Optionalshould_trust_email_verified_connection

should_trust_email_verified_connection?: Management.ConnectionShouldTrustEmailVerifiedConnectionEnum

OptionalsignInEndpoint

signInEndpoint?: string

Optionaltenant_domain

tenant_domain?: string

Optionalthumbprints

thumbprints?: ConnectionThumbprints

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Optionaluser_id_attribute

user_id_attribute?: string

Custom ADFS claim to use as the unique user identifier. When provided, this attribute is prepended to the default user_id mapping list with highest priority. Accepts a string (single ADFS claim name).

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties adfs_serverdomain_aliasesentityIdfedMetadataXmlicon_urlprev_thumbprintsset_user_root_attributesshould_trust_email_verified_connectionsignInEndpointtenant_domainthumbprintsupstream_paramsuser_id_attributenon_persistent_attrs