...
| request | params | response | description |
|---|---|---|---|
| GET /oauth/providers | OAuthProvider array | list of configured identity providers | |
| GET /oauth/redirect | TokenResponse | ||
| POST /oauth/login | username={}&password={} | TokenResponse |
Environment Vars:
| env | default value | description |
|---|---|---|
| TOKEN_SECRET | secret | key to sign the token |
| TOKEN_ISSUER | ONAP SDNC | |
| HOST_URL | null => autodetected | important for reverse proxy use case |
| ODLUX_REDIRECT_URI | /odlux/index.html#/oauth?token= | OAuth redirect will be responded |
| SUPPORT_ODLUSERS | true | login interface enabled for internal odl configured users |
Dataflow example for Login with external Identity Provider (KeyCloak)
| PlantUML Macro |
|---|
@startuml
participant User as user order 1
participant GUI as gui order 2
participant SDNC as sdnc order 3
participant OAUthProvider as oauth order 4
gui -> sdnc: GET /oauth/providers
sdnc -> gui: providers array
user -> gui: Select OAuth provider
gui -> oauth: /loginForm with params
oauth -> gui: loginForm
user -> gui: fill login form
gui -> oauth: POST /login with credentials
oauth -> gui: [301] to redirectURI
gui -> sdnc: GET /oauth/redirect with params
sdnc -> oauth:POST /oauth2/token with params
oauth -> sdnc: OAuthToken with roles
sdnc -> sdnc: create odl bearer token with with roles
sdnc -> gui: odl bearer token
@enduml |
...