Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.
swagger-ui-plugin-saml-auth / 0.0.4

swagger-ui-plugin-saml-auth 0.0.4

Install from the command line:
Learn more about npm packages
$ npm install @dsaidgovsg/swagger-ui-plugin-saml-auth@0.0.4
Install via package.json:
"@dsaidgovsg/swagger-ui-plugin-saml-auth": "0.0.4"

About this version

@dsaidgovsg/swagger-ui-plugin-saml-auth

This is a SAML authentication plugin for Swagger UI.

Prerequisites

Install

Add github npm registry to .npmrc,

# .npmrc
always-auth = true
@dsaidgovsg:registry=https://npm.pkg.github.com

Install the package,

$ npm install @dsaidgovsg/swagger-ui-plugin-saml-auth

Usage

import samlAuthPlugin from '@dsaidgovsg/swagger-ui-plugin-saml-auth'

// swagger-ui initialization
  SwaggerUI({
    plugins: [
      samlAuthPlugin,
      ...
    ]
  })

Swagger Configuration

components:
  securitySchemes:
    SamlAuth:
      # base config
      type: http
      scheme: bearer
      saml: true
      # urls
      loginUrl: /auth/saml/sso/
      logoutUrl: /auth/saml/slo

security:
  - SamlAuth: []

Details

Assets

  • swagger-ui-plugin-saml-auth-0.0.4.tgz

Download activity

  • Total downloads 23
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all