Module trigger.identityserver
ballerinax/trigger.identityserver Ballerina library
Overview
The ballerinax/trigger.identityserver module provides a Listener to grasp events triggered from your WSO2 Identity Server. This functionality is provided by the WSO2 Identity Server webhooks.
The WSO2 Identity Server Trigger module allows you to listen to the following events when they occur in your WSO2 Identity Server organization:
- User account management events
- User created event
- User profile updated event
- User disabled event
- User enabled event
- User account locked event
- User account unlocked event
- User deleted event
Learn more about WSO2 Identity Server events.
Compatibility
| Version | |
|---|---|
| Ballerina Language | Ballerina Swan Lake 2201.12.0 |
Service types
trigger.identityserver: UserOperationService
Triggers when a new event related to user operations is received. Available actions: onCreateUser, onUpdateUser, onDeleteUser, onEnableUser, onDisableUser, onUserAccountLock, onUserAccountUnlock
onCreateUser
function onCreateUser(GenericUserOperationEvent event) returns error?Parameters
- event GenericUserOperationEvent -
onUpdateUser
function onUpdateUser(UserProfileUpdateOperationEvent event) returns error?Parameters
- event UserProfileUpdateOperationEvent -
onDeleteUser
function onDeleteUser(GenericUserOperationEvent event) returns error?Parameters
- event GenericUserOperationEvent -
onEnableUser
function onEnableUser(GenericUserOperationEvent event) returns error?Parameters
- event GenericUserOperationEvent -
onDisableUser
function onDisableUser(GenericUserOperationEvent event) returns error?Parameters
- event GenericUserOperationEvent -
onUserAccountLock
function onUserAccountLock(GenericUserOperationEvent event) returns error?Parameters
- event GenericUserOperationEvent -
onUserAccountUnlock
function onUserAccountUnlock(GenericUserOperationEvent event) returns error?Parameters
- event GenericUserOperationEvent -
Listeners
trigger.identityserver: Listener
attach
function attach(GenericServiceType serviceRef, () attachPoint) returns error?detach
function detach(GenericServiceType serviceRef) returns error?Parameters
- serviceRef GenericServiceType -
'start
function 'start() returns error?gracefulStop
function gracefulStop() returns error?immediateStop
function immediateStop() returns error?Records
trigger.identityserver: GenericClaimData
Represent generic claim data.
Fields
- uri string - Claim URI
- value string - Claim value
trigger.identityserver: GenericOrganizationData
Represent generic organization data.
Fields
- id string - Organization ID
- name string - Organization name
- orgHandle string - Organization handle
- depth int - Organization depth
trigger.identityserver: GenericPayloadType
Represent generic payload data.
Fields
- iss string - Issuer
- jti string - JWT ID
- iat int - Issued at
- rci string - RCI value
- events json - Event data
trigger.identityserver: GenericSecurityData
Represent generic security data.
Fields
- iss string - Issuer
- jti string - JWT ID
- iat int - Issued at
- rci string - RCI value
trigger.identityserver: GenericTenantData
Represent generic tenant data.
Fields
- id string - Tenant ID
- name string - Tenant name
trigger.identityserver: GenericUserData
Represent generic user data.
Fields
- id string - User ID
- claims GenericClaimData[] - User claims
- organization GenericOrganizationData - User organization
- ref string - User reference
trigger.identityserver: GenericUserOperationData
Represent generic user operation data.
Fields
- initiatorType? string - Type of the initiator
- user GenericUserData - User data
- tenant GenericTenantData - Tenant data
- organization GenericOrganizationData - Organization data
- userStore GenericUserStoreData - User store data
- action? string - Action performed
trigger.identityserver: GenericUserOperationEvent
Represent generic user operation event.
Fields
- eventData GenericUserOperationData - User operation data
- securityData GenericSecurityData - Security data
trigger.identityserver: GenericUserStoreData
Represent generic user store data.
Fields
- id string - User store ID
- name string - User store name
trigger.identityserver: ListenerConfig
Listener configuration.
Fields
- webhookSecret string - Webhook secret configured in IS.
trigger.identityserver: UserProfileUpdateData
Represent user profile update data.
Fields
- initiatorType? string - Type of the initiator
- user UserProfileUpdateUserData - User profile update data
- tenant GenericTenantData - Tenant data
- organization GenericOrganizationData - Organization data
- userStore GenericUserStoreData - User store data
- action? string - Action performed
trigger.identityserver: UserProfileUpdateOperationEvent
Represent user profile update operation event.
Fields
- eventData UserProfileUpdateData - User profile update data
- securityData GenericSecurityData - Security data
trigger.identityserver: UserProfileUpdateUserData
Represent user profile update data.
Fields
- id string - User ID
- organization GenericOrganizationData - User organization
- ref string - User reference
- addedClaims? GenericClaimData[] - Claims added in the user profile update
- updatedClaims? GenericClaimData[] - Claims updated in the user profile update
- removedClaims? GenericClaimData[] - Claims removed in the user profile update
Union types
trigger.identityserver: GenericDataType
GenericDataType
Represent generic data type.
Simple name reference types
trigger.identityserver: GenericServiceType
GenericServiceType
Import
import ballerinax/trigger.identityserver;Other versions
0.9.0