feat(admin-ui): execute custom business logic using web hook

[duttarnab]

We need a feature in Admin UI to exceute the custom business logic by calling webhook url.

Points discussed

• There was a conversation on Jans about how to execute extra business logic in the Admin UI
• I have an idea... what if we allow the Admin to create Webhooks.
• We could add this as an optional configuration in the Admin UI properties...
• For example, you could set this for any create / update / delete for a user...
• This would enable the AdminUI to call external components without having to implement a new interception script...
• Ideally, we'd have one place where admins coulds manage webhooks.
• And then in the UserForm, you would select the webhook to run based on the Webhook Name
• Don't we already have an approve and Log function in the Admin UI? Does this approve / admin workflow also apply to user edits? (It should...)
• Then we could have a workflow where you approve the change, make an audit log for why it happened, and then we run a webhook to authorize.

Sequence diagram

title Webhook flow

actor User
database Jans DB

User<->Admin UI: login
User->Admin UI: Register webhook\n (URL, HTTP methods etc.)
Admin UI->Jans Config Api: call api to save webhook details\n in Admin UI configuration
Jans Config Api->Jans DB: webhook details
Jans DB-> Jans Config Api:
Jans Config Api->Admin UI: response
alt webhook call flow
User->Admin UI: edit user details
Admin UI->User: show audit log dialog
User-> Admin UI: enter comments and submit
Admin UI->Jans Config Api: /auditlog
Jans Config Api<->Jans DB: fetches webhook details
Jans Config Api->3rd party server: triggers webhook url
alt success
3rd party server->Jans Config Api: response
Jans Config Api->Jans Config Api: performs user update and audit log
Jans Config Api->Admin UI: success response
else failure
3rd party server->Jans Config Api: response
Jans Config Api->Jans Config Api: rejects user update
Jans Config Api->Admin UI: failure response
end
end

[duttarnab]

[duttarnab]

Admin UI features which will trigger Webhook

Feature Name	Action	Permission
Custom Script	Add/Edit	https://jans.io/oauth/config/scripts.write
Custom Script	Delete	https://jans.io/oauth/config/scripts.delete
FIDO Configuration	Edit	https://jans.io/oauth/jans-auth-server/config/properties.write
Jans Link	Edit	https://jans.io/oauth/config/jans-link.write
OIDC Clients	Add/Edit	https://jans.io/oauth/config/openid/clients.write
OIDC Clients	Delete	https://jans.io/oauth/config/openid/clients.delete
Scopes	Add/Edit	https://jans.io/oauth/config/scopes.write
Scopes	Delete	https://jans.io/oauth/config/scopes.delete
Schema:Person	Add/Edit	https://jans.io/oauth/config/attributes.write
Schema:Person	Delete	https://jans.io/oauth/config/attributes.delete
SCIM Configuration	Edit	https://jans.io/scim/config.write
SMTP Configuration	Edit	https://jans.io/oauth/config/smtp.write
Users	Add/Edit	https://jans.io/oauth/config/user.write
Users	Delete	https://jans.io/oauth/config/user.delete
Authn	Edit

[duttarnab]

Screen Design

[duttarnab]

1. The admin can add a new webhook . POST /admin-ui/webhook.
2. The admin can edit an existing webhook. PUT /admin-ui/webhook.
3. The admin can delete an existing webhook. DELETE /admin-ui/webhook.
4. On opening a webhook details, the admin would be able to see the admin-ui features already to mapped to the webhook. On opening it will call GET /admin-ui/webhook/features/{webhookId} to get all the features mapped.
5. On submitting the form of any Admin UI feature it will first show a modal listing the enabled webhooks mapped to it.
   (WIll develop and update API). On accepting the Admin UI will trigger all the webhooks and show the result. --- GET /admin-ui/webhook/trigger/{featureId}
   If all webhooks are successful then it will call the audit endpoint to log the result.
   At the end it will display comments dialog to submit the form.
6. In case there is not webhooks mapped to the feature then it will skip showing webhook dialog.