Skip to content

basalt / auth-saml/src / SamlClient

Interface: SamlClient ​

Defined in: auth-saml/src/index.ts:42

The node-saml surface this package uses — kept minimal so the underlying library (which does the XML-DSig verification) is injectable in tests.

Methods ​

generateServiceProviderMetadata() ​

> generateServiceProviderMetadata(decryptionCert, signingCert?): string

Defined in: auth-saml/src/index.ts:45

Parameters ​

decryptionCert ​

string | null

signingCert? ​

string | null

Returns ​

string


getAuthorizeUrlAsync() ​

> getAuthorizeUrlAsync(relayState, host, options): Promise<string>

Defined in: auth-saml/src/index.ts:43

Parameters ​

relayState ​

string

host ​

string | undefined

options ​

Record<string, unknown>

Returns ​

Promise<string>


validatePostResponseAsync() ​

> validatePostResponseAsync(container): Promise<{ loggedOut: boolean; profile: SamlProfile | null; }>

Defined in: auth-saml/src/index.ts:44

Parameters ​

container ​

Record<string, string>

Returns ​

Promise<{ loggedOut: boolean; profile: SamlProfile | null; }>

Released under the MIT License.