c6eb8edb5f
* add `onFound` callback to schemas * add warning to method docs (for #4957) * implement Docker OAuth2 init block support * update docs * add OAUTH_SCOPE_SEPARATOR * drop OAuth env from Dockerfile and run script * don't indent the first oauth block line * drop unused `dedent` import * touch up warning message * add more test cases * return an empty block if no OAuth content is generated * fix broken doc line
1.7 KiB
1.7 KiB
OAuth2 configuration
You can configure OAuth2 authorization by calling the
initOAuth method.
| Property name | Docker variable | Description |
|---|---|---|
| clientId | OAUTH_CLIENT_ID |
Default clientId. MUST be a string |
| clientSecret | OAUTH_CLIENT_SECRET |
🚨 Never use this parameter in your production environemnt.
It exposes cruicial security information. This feature is intended for
dev/test environments only. 🚨 Default clientSecret. MUST be a string |
| realm | OAUTH_REALM |
realm query parameter (for oauth1) added to
authorizationUrl and tokenUrl. MUST be a
string |
| appName | OAUTH_APP_NAME |
application name, displayed in authorization popup. MUST be a string |
| scopeSeparator | OAUTH_SCOPE_SEPARATOR |
scope separator for passing scopes, encoded before calling, default
value is a space (encoded value %20). MUST be a string |
| additionalQueryStringParams | OAUTH_ADDITIONAL_PARAMS |
Additional query parameters added to authorizationUrl
and tokenUrl. MUST be an object |
| useBasicAuthenticationWithAccessCodeGrant | Unavailable | Only activated for the accessCode flow. During the
authorization_code request to the tokenUrl,
pass the Client
Password using the HTTP Basic Authentication scheme
(Authorization header with
Basic base64encode(client_id + client_secret)). The default
is false |
const ui = SwaggerUI({...})
// Method can be called in any place after calling constructor SwaggerUIBundle
ui.initOAuth({
clientId: "your-client-id",
clientSecret: "your-client-secret-if-required",
realm: "your-realms",
appName: "your-app-name",
scopeSeparator: " ",
additionalQueryStringParams: {test: "hello"}
})