swagger-ui-plugin-saml-auth

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

This is a SAML authentication plugin for Swagger UI.

Prerequisites

• swagger-ui
• react

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: []