This repository has been archived by the owner on Jun 1, 2023. It is now read-only.
swagger-ui-plugin-otp-auth
/
0.0.4
swagger-ui-plugin-otp-auth 0.0.4
Install from the command line:
Learn more about npm packages
$ npm install @dsaidgovsg/swagger-ui-plugin-otp-auth@0.0.4
Install via package.json:
"@dsaidgovsg/swagger-ui-plugin-otp-auth": "0.0.4"
About this version
This is a OTP authentication plugin for Swagger UI.
Add github npm registry to .npmrc,
# .npmrc
always-auth = true
@dsaidgovsg:registry=https://npm.pkg.github.comInstall the package,
$ npm install @dsaidgovsg/swagger-ui-plugin-otp-authimport OtpAuthPlugin from '@dsaidgovsg/swagger-ui-plugin-otp-auth'
// swagger-ui initialization
SwaggerUI({
plugins: [
OtpAuthPlugin,
...
]
})components:
securitySchemes:
OtpAuth:
# base config
type: http
scheme: bearer
otp: true
# token url
tokenUrl: /api/otp/
# request path and method
requestOtpPath: /new
requestOtpMethod: post
requestOtpQuery:
service: service-name
# auth path and method
authPath: /authenticate
authMethod: post
authQuery:
service: service-name
expiry: 10800
security:
- OtpAuth: []Details
- swagger-ui-plugin-otp-auth
-
dsaidgovsg
- over 1 year ago
- MIT
- 9 dependencies
Assets
- swagger-ui-plugin-otp-auth-0.0.4.tgz
Download activity
- Total downloads 23
- Last 30 days 0
- Last week 0
- Today 0