Class ServiceProvider

constructor

• new ServiceProvider(
      config: ResolvedConfig,
      idp: IdpMetadata | undefined,
      options?: ServiceProviderOptions,
  ): ServiceProvider

  Parameters

  • config: ResolvedConfig
  • idp: IdpMetadata | undefined
  • options: ServiceProviderOptions = {}

  Returns ServiceProvider

Readonlyconfig

idp

• get idp(): IdpMetadata

  The identity provider, as its metadata describes it.

  Returns IdpMetadata

acs

• acs(request: AcsRequest, options?: AcsOptions): Promise<SamlLogin>

  Reads and validates the Response at the assertion consumer service, on whichever binding it came: a POSTed SAMLResponse, a SAMLResponse in the query (HTTP-Redirect), or a SAMLart in the query or the form (HTTP-Artifact, resolved here over SOAP). Returns who signed in; throws a SamlError otherwise.

  Parameters

  • request: AcsRequest
  • options: AcsOptions = {}

  Returns Promise<SamlLogin>

Staticcreate

• create(
      config: SamlConfig,
      options?: ServiceProviderOptions & { baseDir?: string },
  ): Promise<ServiceProvider>

  Builds a service provider from a configuration object and loads the identity provider's metadata.

  Parameters

  • config: SamlConfig
  • options: ServiceProviderOptions & { baseDir?: string } = {}

  Returns Promise<ServiceProvider>

StaticfromFile

• fromFile(
      path: string,
      overrides?: Partial<SamlConfig>,
      options?: ServiceProviderOptions,
  ): Promise<ServiceProvider>

  Builds a service provider from a JSON configuration file and loads the identity provider's metadata.

  Parameters

  • path: string
  • overrides: Partial<SamlConfig> = {}
  • options: ServiceProviderOptions = {}

  Returns Promise<ServiceProvider>

login

• login(options?: LoginOptions): LoginRequest

  Builds a signed AuthnRequest. Send the browser where the answer says, and keep id with that browser.

  Parameters

  • options: LoginOptions = {}

  Returns LoginRequest

metadata

• metadata(): string

  This service provider's metadata. Serve it at the entityID, or give it to the identity provider.

  Returns string

refreshMetadata

• refreshMetadata(): Promise<IdpMetadata>

  (Re)reads the identity provider's metadata from where the configuration says it is. Call it to pick up a key rollover.

  Returns Promise<IdpMetadata>