• management
• Management
• ConnectionOptionsSaml

Interface ConnectionOptionsSaml

Options for the 'samlp' connection

interface ConnectionOptionsSaml {
non_persistent_attrs?: ConnectionNonPersistentAttrs;
assertion_decryption_settings?: ConnectionAssertionDecryptionSettings;
cert?: string;
decryptionKey?: ConnectionDecryptionKeySaml;
digestAlgorithm?: Management.ConnectionDigestAlgorithmEnumSaml;
domain_aliases?: ConnectionDomainAliasesSaml;
entityId?: string;
icon_url?: string;
idpinitiated?: ConnectionOptionsIdpinitiatedSaml;
protocolBinding?: Management.ConnectionProtocolBindingEnumSaml;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
signInEndpoint?: string;
signSAMLRequest?: boolean;
signatureAlgorithm?: Management.ConnectionSignatureAlgorithmEnumSaml;
tenant_domain?: string;
thumbprints?: ConnectionThumbprintsSaml;
upstream_params?: ConnectionUpstreamParams;
debug?: boolean;
deflate?: boolean;
destinationUrl?: string;
disableSignout?: boolean;
fieldsMap?: Management.ConnectionFieldsMapSaml;
global_token_revocation_jwt_iss?: string;
global_token_revocation_jwt_sub?: string;
metadataUrl?: string;
metadataXml?: string;
recipientUrl?: string;
requestTemplate?: string;
signingCert?: string;
signing_key?: ConnectionSigningKeySaml;
signOutEndpoint?: string;
user_id_attribute?: string;
key: string: any;
}

Hierarchy (View Summary)

• ConnectionOptionsCommonSaml
• ConnectionOptionsCommon
  • ConnectionOptionsSaml

Indexable

Accepts any additional properties

Index

Properties

non_persistent_attrs?assertion_decryption_settings?cert?decryptionKey?digestAlgorithm?domain_aliases?entityId?icon_url?idpinitiated?protocolBinding?set_user_root_attributes?signInEndpoint?signSAMLRequest?signatureAlgorithm?tenant_domain?thumbprints?upstream_params?debug?deflate?destinationUrl?disableSignout?fieldsMap?global_token_revocation_jwt_iss?global_token_revocation_jwt_sub?metadataUrl?metadataXml?recipientUrl?requestTemplate?signingCert?signing_key?signOutEndpoint?user_id_attribute?

Properties

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

Optionalassertion_decryption_settings

assertion_decryption_settings?: ConnectionAssertionDecryptionSettings

Optionalcert

cert?: string

OptionaldecryptionKey

decryptionKey?: ConnectionDecryptionKeySaml

OptionaldigestAlgorithm

digestAlgorithm?: Management.ConnectionDigestAlgorithmEnumSaml

Optionaldomain_aliases

domain_aliases?: ConnectionDomainAliasesSaml

OptionalentityId

entityId?: string

Optionalicon_url

icon_url?: string

Optionalidpinitiated

idpinitiated?: ConnectionOptionsIdpinitiatedSaml

OptionalprotocolBinding

protocolBinding?: Management.ConnectionProtocolBindingEnumSaml

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

OptionalsignInEndpoint

signInEndpoint?: string

OptionalsignSAMLRequest

signSAMLRequest?: boolean

OptionalsignatureAlgorithm

signatureAlgorithm?: Management.ConnectionSignatureAlgorithmEnumSaml

Optionaltenant_domain

tenant_domain?: string

Optionalthumbprints

thumbprints?: ConnectionThumbprintsSaml

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Optionaldebug

debug?: boolean

Optionaldeflate

deflate?: boolean

OptionaldestinationUrl

destinationUrl?: string

OptionaldisableSignout

disableSignout?: boolean

When true, disables sending SAML logout requests (SingleLogoutService) to the identity provider during user sign-out. The user will be logged out of Auth0 but will remain logged into the identity provider. Defaults to false (federated logout enabled).

OptionalfieldsMap

fieldsMap?: Management.ConnectionFieldsMapSaml

Optionalglobal_token_revocation_jwt_iss

global_token_revocation_jwt_iss?: string

Optionalglobal_token_revocation_jwt_sub

global_token_revocation_jwt_sub?: string

OptionalmetadataUrl

metadataUrl?: string

OptionalmetadataXml

metadataXml?: string

OptionalrecipientUrl

recipientUrl?: string

OptionalrequestTemplate

requestTemplate?: string

OptionalsigningCert

signingCert?: string

Optionalsigning_key

signing_key?: ConnectionSigningKeySaml

OptionalsignOutEndpoint

signOutEndpoint?: string

Optionaluser_id_attribute

user_id_attribute?: string

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties non_persistent_attrsassertion_decryption_settingscertdecryptionKeydigestAlgorithmdomain_aliasesentityIdicon_urlidpinitiatedprotocolBindingset_user_root_attributessignInEndpointsignSAMLRequestsignatureAlgorithmtenant_domainthumbprintsupstream_paramsdebugdeflatedestinationUrldisableSignoutfieldsMapglobal_token_revocation_jwt_issglobal_token_revocation_jwt_submetadataUrlmetadataXmlrecipientUrlrequestTemplatesigningCertsigning_keysignOutEndpointuser_id_attribute