Webhooks
AdminUI contains three webhooks to extend AdminUI functionality and integrate it with your OpenIddict and custom Identity needs. These webhooks hold no functionality themselves but call secured endpoints to trigger outside functionality, this could within your OpenIddict instance or a separate API.
Password reset webhook- This webhook allows AdminUI to trigger custom password reset logic contained elsewhere.User registration webhook- This webhook will trigger any additional account setup process your security solution might have.Reset mfa webhook- This webhook will trigger custom logic used to reset a user's Multi-Factor Authentication.
Webhook Configuration
Webhooks can be configured from settings. A detailed explanation of this settings can be found here.
If you have configured any webhook, AdminUI will create a client for you to use as a webhook client. The client will use the default admin_ui_webhooks protecting scope. The client also uses the client_credentials grant type.
If AdminUI cannot find any values for ClientId or ClientSecret configuration fields, it will use a default clientId (admin_ui_webhooks) and a default client secret.
Webhooks Page
You can visualize the webhook configuration by navigating to the Webhooks tab in the Settings area of AdminUI.
Triggering Password Reset and Reset MFA
After navigating to a user details page, you will find the two buttons used to trigger either the Password Reset webhook or the Reset MFA webhook.
- If the webhook has been configured, clicking on the webhook button will trigger the webhook.
- If the webhook has not been configured, clicking on the webhook button will direct you to documentation that will inform you on how to configure the webhook.
Triggering User Registration Webhook
If account creation succeeds and the User registration webhook has been enabled, then the webhook will trigger. If the user registration webhook has not been enabled user registration will still complete successfully, however the webhook will not be called.
The recommended way to use this webhook is to send an email to the user with a link to activate their account and set their initial password.
Authorization
The webhooks will need to be to secured by your OpenIddict solution. To ensure your webhooks are secured against public use, they should check for a bearer token, issued by your OpenIddict installation, that contains the webhook scopes.
The configuration of a webhook endpoint is detailed in the Webhook Endpoint Configuration page.