Ballerina library
trigger.asgardeo
Module trigger.asgardeo
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_trigger.asgardeo_0.1.3.png)
ballerinax/trigger.asgardeo Ballerina library
0.1.3
Overview
The ballerinax/trigger.asgardeo
module provides a Listener to grasp events triggered from your Asgardeo App. This functionality is provided by Asgardeo Events API.
Quickstart
To use the Asgardeo listener, please go the Choreo Console and create a webhook
Listeners![](/images/permalink.svg)
trigger.asgardeo: Listener![](/images/permalink.svg)
attach![](/images/permalink.svg)
Isolated Function
function attach(GenericServiceType serviceRef, () attachPoint) returns error?
detach![](/images/permalink.svg)
Isolated Function
function detach(GenericServiceType serviceRef) returns error?
Parameters
- serviceRef GenericServiceType -
'start![](/images/permalink.svg)
Isolated Function
function 'start() returns error?
gracefulStop![](/images/permalink.svg)
Isolated Function
function gracefulStop() returns error?
immediateStop![](/images/permalink.svg)
Isolated Function
function immediateStop() returns error?
Records![](/images/permalink.svg)
trigger.asgardeo: AddUserData![](/images/permalink.svg)
Fields
- organizationId int? -
- ref string? -
- organizationName string? -
- userStoreName string? -
- userOnboardMethod string? -
- userName string? -
- roleList string[]? -
- userId string? -
trigger.asgardeo: AddUserEvent![](/images/permalink.svg)
Fields
- eventData AddUserData? -
- securityData GenericSecurityData? -
trigger.asgardeo: GenericEvent![](/images/permalink.svg)
Fields
- eventData GenericUserData? -
- securityData GenericSecurityData? -
trigger.asgardeo: GenericSecurityData![](/images/permalink.svg)
Fields
- aud string? - Audience of the event.
- iss string? - Name of the issuer.
- iat int? - Issued timestamp of the event.
- jti string? - Event id.
trigger.asgardeo: GenericUserData![](/images/permalink.svg)
Fields
- organizationId int? -
- ref string? -
- organizationName string? -
- userStoreName string? -
- userName string? -
- userId string? -
trigger.asgardeo: ListenerConfig![](/images/permalink.svg)
Fields
- clientId string -
- clientSecret string -
- hubSecret string -
- organization string -
- tokenEndpointHost string -
- callbackURL string -
- hubURL string -
trigger.asgardeo: LoginSuccessData![](/images/permalink.svg)
Fields
- organizationId int? -
- ref string? -
- organizationName string? -
- userStoreName string? -
- serviceProvider string? -
- userName string? -
- userId string? -
trigger.asgardeo: LoginSuccessEvent![](/images/permalink.svg)
Fields
- eventData LoginSuccessData? -
- securityData GenericSecurityData? -
trigger.asgardeo: User![](/images/permalink.svg)
Fields
- userName string? -
- userId string? -
trigger.asgardeo: UserGroupUpdateData![](/images/permalink.svg)
Fields
- organizationId int? -
- ref string? -
- groupName string? -
- organizationName string? -
- groupId string? -
- userStoreName string? -
- removedUsers User[]? - A list of removed users from the group.
- addedUsers User[]? - A list of added users to the group.
trigger.asgardeo: UserGroupUpdateEvent![](/images/permalink.svg)
Fields
- eventData UserGroupUpdateData? -
- securityData GenericSecurityData? -
Object types![](/images/permalink.svg)
trigger.asgardeo: LoginService![](/images/permalink.svg)
onLoginSuccess![](/images/permalink.svg)
Remote Function
function onLoginSuccess(LoginSuccessEvent event) returns error?
Parameters
- event LoginSuccessEvent -
trigger.asgardeo: RegistrationService![](/images/permalink.svg)
onAddUser![](/images/permalink.svg)
Remote Function
function onAddUser(AddUserEvent event) returns error?
Parameters
- event AddUserEvent -
onConfirmSelfSignup![](/images/permalink.svg)
Remote Function
function onConfirmSelfSignup(GenericEvent event) returns error?
Parameters
- event GenericEvent -
onAcceptUserInvite![](/images/permalink.svg)
Remote Function
function onAcceptUserInvite(GenericEvent event) returns error?
Parameters
- event GenericEvent -
trigger.asgardeo: UserOperationService![](/images/permalink.svg)
onLockUser![](/images/permalink.svg)
Remote Function
function onLockUser(GenericEvent event) returns error?
Parameters
- event GenericEvent -
onUnlockUser![](/images/permalink.svg)
Remote Function
function onUnlockUser(GenericEvent event) returns error?
Parameters
- event GenericEvent -
onUpdateUserCredentials![](/images/permalink.svg)
Remote Function
function onUpdateUserCredentials(GenericEvent event) returns error?
Parameters
- event GenericEvent -
onDeleteUser![](/images/permalink.svg)
Remote Function
function onDeleteUser(GenericEvent event) returns error?
Parameters
- event GenericEvent -
onUpdateUserGroup![](/images/permalink.svg)
Remote Function
function onUpdateUserGroup(UserGroupUpdateEvent event) returns error?
Parameters
- event UserGroupUpdateEvent -
Union types![](/images/permalink.svg)
trigger.asgardeo: GenericDataType![](/images/permalink.svg)
GenericDataType
trigger.asgardeo: GenericServiceType![](/images/permalink.svg)
GenericServiceType
Import
import ballerinax/trigger.asgardeo;
Metadata
Released date: almost 2 years ago
Version: 0.1.3
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.1.1
GraalVM compatible: Yes
Pull count
Total: 2718
Current verison: 109
Weekly downloads
Keywords
IT Operations/Authentication
Cost/Freemium
Contributors
Dependencies
See more...