Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

Events

Public event payload taxonomy

search

Public event payload taxonomy

This section lists the public events that the modules in the OneWelcome Identity Platform generate. It includes the event names, descriptions, and fields that are part of the event payload. Events are transmitted in JSON format.

The following is a sample event in JSON format:

{
  "metadata": {
     "type":"AuthorizationGroupDeletedEvent"
     //other metadata fields, check documentation for details
  },
  "payload": {
     "authorizationGroupId":"a4a474cc-7347-4de1-8f21-9dd2939346dc"
  }
}

Public events for the Access module

Event type Description Payload fields
AssuranceLevelCreatedEvent Assurance Level Created id:String, name:String, value:Integer
AssuranceLevelDeletedEvent Assurance Level Deleted id:String
AssuranceLevelUpdatedEvent Assurance Level Updated id:String, name:String, value:Integer
DeviceDeregisteredEvent A device with all registered users has been revoked. clientId:String
DeviceRegisteredEvent A device has been registered clientId:String, appName:String, platform:String, appVersion:String, osVersion:String
DeviceUpdatedEvent A device has been updated clientId:String, appName:String, platform:String, appVersion:String, osVersion:String
UserDeviceDeregisteredEvent The user's registration has been removed from the client userId:String, clientId:String
UserDeviceRegisteredEvent User registered on client. userId:String, clientId:String

Public events for the delegated administration module

Event type Description Payload fields
AuthorizationGroupAttributesChangedEvent Attributes are changed for the authorization group authorizationGroupId:UUID, attributesAdded:List, attributesUpdated:List, attributesRemoved:List
AuthorizationGroupCreatedEvent Authorization group is created authorizationGroupId:UUID, name:String, parentId:UUID
AuthorizationGroupDeletedEvent Authorization group is deleted authorizationGroupId:UUID
AuthorizationGroupMemberAddedEvent Member is added to authorization group authorizationGroupId:UUID, userId:UUID
AuthorizationGroupMemberRemovedEvent Member is removed from authorization group authorizationGroupId:UUID, userId:UUID
AuthorizationGroupPoliciesChangedEvent Policies of authorization group have been changed authorizationGroupId:UUID, policiesAdded:List, policiesRemoved:List
AuthorizationGroupResourcesChangedEvent Resources of authorization group have been changed authorizationGroupId:UUID, resourcesAdded:List, resourcesRemoved:List
AuthorizationGroupUpdatedEvent Authorization group is updated authorizationGroupId:UUID, oldName:String, newName:String
AuthorizationMemberPermissionAssignmentsChangedEvent Member permissions have been changed for the authorization group authorizationGroupId:UUID, userId:UUID, permissionsAdded:List, permissionsRemoved:List
AuthorizationMemberPolicyAssignmentsChangedEvent Member policies have changed for the authorization group authorizationGroupId:UUID, userId:UUID, policiesAdded:List, policiesRemoved:List
AuthorizationMemberResourceAssignmentsChangedEvent Members resources have been changed for the authorization group authorizationGroupId:UUID, userId:UUID, resourcePrivilegesAdded:List, resourcePrivilegesRemoved:List
AuthorizationPolicyCreatedEvent Policy is created id:UUID, name:String
AuthorizationPolicyDeletedEvent Policy is deleted id:UUID
AuthorizationPolicyUpdatedEvent Policy is updated id:UUID, oldName:String, newName:String
AuthorizationResourceCreatedEvent Resource is created id:UUID, name:String, externalId:String, resourceTypeId:UUID
AuthorizationResourceDeletedEvent Resource is deleted id:UUID
AuthorizationResourceTypeCreatedEvent Resource type is created id:UUID, name:String, policyId:UUID
AuthorizationResourceTypeDeletedEvent Resource type is deleted id:UUID
AuthorizationResourceTypeUpdatedEvent Resource type is updated id:UUID, oldName:String, newName:String
AuthorizationResourceUpdatedEvent Resource is updated id:UUID, oldName:String, newName:String, oldExternalId:String, newExternalId:String

Model objects

Model object Fields
Attribute key:String, value:String
Permission One of GROUP_MANAGE, GROUP_POLICY_MANAGE, GROUP_RESOURCE_MANAGE, PERMISSION_MANAGE, PERSON_POLICY_MANAGE, PERSON_RESOURCE_MANAGE, GROUP_MEMBER_MANAGE, POLICY_MANAGE, RESOURCE_MANAGE
ResourcePrivilege resourceId:UUID, privilegeId:UUID
Event type Description Payload fields
ConsentReceiptCreatedEvent A consent receipt has been created consentReceiptId:String, status:ConsentReceiptStatus, principal:Principal, config:Config, confirmationMessage:ConfirmationMessage
ConsentReceiptDeletedEvent A consent receipt has been deleted consentReceiptId:String
ConsentReceiptUpdatedEvent A consent receipt has been updated consentReceiptId:String, status:ConsentReceiptStatus

Model objects

Model object Fields
AttributeConsent version:String, language:String, effectiveDate:String, processingPurpose:String, listOfAttributes:List, legalBasis:String
AuthMode One of OnBehalfOf, MachineToMachine, DirectUser
ChannelType One of EMAIL
Config type:ConsentType, name:String, version:String, optInType:OptInType, document:DocumentConsent, attribute:AttributeConsent
ConfirmationMessage channel:ChannelType, emailTo:String
ConsentReceiptStatus One of agreed, pending, rejected
ConsentType One of document, attribute
DocumentConsent version:String, language:String, effectiveDate:String, url:String, processingPurpose:String
OptInType One of direct, double
Principal authMode:AuthMode, clientId:String, userId:String, actingUserId:String

Public events for the credentials module

Event type Description Payload fields
PasswordUpdatedEvent User's password is updated userId:UUID

Public events for the DMv2 module

Event type Description Payload fields
DelegationApplicationCreatedEvent An application has been created applicationId:String, accessApplicationId:String, name:String, description:String, type:String, status:DMv2Status, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationApplicationDeletedEvent An application has been deleted applicationId:String
DelegationApplicationUpdatedEvent An application has been updated applicationId:String, accessApplicationId:String, name:String, description:String, type:String, status:DMv2Status, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationCustomObjectConfigurationCreatedEvent A customObjectType has been created customObjectType:String, createSchema:Object, updateSchema:Object
DelegationCustomObjectConfigurationDeletedEvent A customObjectType has been deleted customObjectType:String
DelegationCustomObjectConfigurationUpdatedEvent A customObjectType has been updated customObjectType:String, createSchema:Object, updateSchema:Object
DelegationCustomObjectCreatedEvent A customObject has been created customObjectId:String, customObjectType:String
DelegationCustomObjectDeletedEvent A customObject has been deleted customObjectId:String
DelegationCustomObjectUpdatedEvent A customObject has been updated customObjectId:String, customObjectType:String
DelegationCustomRelationshipsCreatedEvent A customRelationship has been created customRelationshipType:String, customRelationshipId:String, from:DMv2Entity, to:DMv2Entity
DelegationCustomRelationshipsDeletedEvent A customRelationship has been deleted customRelationshipId:String
DelegationCustomRelationshipsUpdatedEvent A customRelationship has been updated customRelationshipType:String, customRelationshipId:String, from:DMv2Entity, to:DMv2Entity
DelegationCustomRelationshipTypeCreatedEvent A customRelationshipType has been created customRelationshipType:String, description:String, restrictions:List, createSchema:Object, updateSchema:Object
DelegationCustomRelationshipTypeDeletedEvent A customRelationshipType has been deleted customRelationshipType:String
DelegationCustomRelationshipTypeUpdatedEvent A customRelationshipType has been updated customRelationshipType:String, description:String, restrictions:List, createSchema:Object, updateSchema:Object
DelegationInvitationAcceptedEvent An invitation was accepted invitationId:String
DelegationInvitationCreatedEvent An invitation was created invitationId:String, expirationTime:OffsetDateTime
DelegationInvitationDeletedEvent An invitation was deleted invitationId:String
DelegationInvitationResendEvent An invitation was resent invitationId:String, expirationTime:OffsetDateTime
DelegationOrganizationApplicationAddedEvent One or more applications were added to the organization organizationId:String, applicationIds:List
DelegationOrganizationApplicationRemovedEvent One or more applications were removed from the organization organizationId:String, applicationIds:List
DelegationOrganizationCreatedEvent An organization has been created organizationId:String, parentOrganizationIds:List, name:String, description:String, externalId:String, type:String, status:DMv2Status, customAttributes:Object, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationOrganizationDeletedEvent An organization has been deleted organizationId:String
DelegationOrganizationMemberAddedEvent A member has been added to the organization organizationId:String, userId:String
DelegationOrganizationMemberRemovedEvent A member has been removed from the organization organizationId:String, userId:String
DelegationOrganizationMemberUpdatedEvent A member has been updated in the organization organizationId:String, userId:String, relationships:DMv2Relationships
DelegationOrganizationPermissionAddedEvent One or more permissions were added to the organization organizationId:String, permissionIds:List
DelegationOrganizationPermissionRemovedEvent One or more permissions were removed from the organization organizationId:String, permissionIds:List
DelegationOrganizationRoleAddedEvent One or more roles were added to the organization organizationId:String, roles:List
DelegationOrganizationRoleRemovedEvent One or more roles were removed from the organization organizationId:String, roleIds:List
DelegationOrganizationUpdatedEvent An organization has been updated organizationId:String, parentOrganizationIds:List, name:String, description:String, externalId:String, type:String, status:DMv2Status, customAttributes:Object, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationPermissionCreatedEvent A permission has been created permissionId:String, name:String, description:String, applicationId:String, descriptor:String, type:String, status:DMv2Status, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationPermissionDeletedEvent A permission has been deleted permissionId:String
DelegationPermissionUpdatedEvent A permission has been updated permissionId:String, name:String, description:String, applicationId:String, descriptor:String, type:String, status:DMv2Status, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationRoleCreatedEvent A role has been created roleId:String, name:String, description:String, permissionIds:List, externalId:String, type:String, customAttributes:Object, status:DMv2Status, startDate:OffsetDateTime, endDate:OffsetDateTime
DelegationRoleDeletedEvent A role has been deleted roleId:String
DelegationRolePermissionAddedEvent One or more permissions were added to the role roleId:String, permissionIds:List
DelegationRolePermissionRemovedEvent One or more permissions were removed from the role roleId:String, permissionIds:List
DelegationRoleUpdatedEvent A role has been updated roleId:String, name:String, description:String, permissionIds:List, externalId:String, type:String, customAttributes:Object, status:DMv2Status, startDate:OffsetDateTime, endDate:OffsetDateTime
UserDelegationBlockedEvent The user was blocked userId:String
UserDelegationPermissionsAddedEvent One or more permissions were added to the user userId:String, organizationId:String, permissions:List
UserDelegationPermissionsRemovedEvent One or more permissions were removed from the user userId:String, organizationId:String, permissionIds:List
UserDelegationRolesAddedEvent One or more roles were added to the user userId:String, organizationId:String, roles:List
UserDelegationRolesRemovedEvent One or more roles were removed from the user userId:String, organizationId:String, roleIds:List
UserDelegationUnblockedEvent The user was unblocked userId:String

Model objects

Model object Fields
DMv2Entity id:String, type:String
DMv2RelatedPermission startDate:OffsetDateTime, endDate:OffsetDateTime, permissionId:String
DMv2RelatedRole startDate:OffsetDateTime, endDate:OffsetDateTime, roleId:String
DMv2Relationships add:List, remove:List
DMv2Restrictions from:String, to:String
DMv2Status One of ENABLED, DISABLED

Public events for the identity module

Event type Description Payload fields
IdentityCreatedEvent Identity created by Identity Store application userId:UUID, attributes:List
IdentityDeletedEvent Identity deleted by Identity Store application userId:UUID
IdentityExternalAccountLinkedEvent Identity linked with an External Account in Identity Store application userId:UUID, externalProviderId:String, externalId:String
IdentityExternalAccountUnlinkedEvent Identity unlinked from an External Account in Identity Store application userId:UUID, externalProviderId:String, externalId:String
IdentityModifiedEvent Identity modified by Identity Store application userId:UUID, attributes:List
IdentityProviderLinkedEvent Identity provider is linked to user identityProviderId:String, name:String, authenticationLevel:Integer, userId:UUID
IdentityProviderUnlinkedEvent Identity provider is unlinked from user identityProviderId:String, name:String, authLevel:Integer, userId:UUID
IdentityReplacedEvent Identity replaced in Identity Store application userId:UUID, attributes:List
IdentityStateChangedEvent Identity State Changed by Identity Store application userId:UUID, preState:String, postState:String
IdentityUpdatedEvent Identity is updated userId:UUID, gender:Gender, emailAddresses:List, phoneNumbers:List, addresses:List
, customAttributes:List, name:Name
InvitationGeneratedEvent Invitation is generated userId:UUID
SchemaAttributesAddedEvent Attributes are added for one of the following resource identity/group/external_account or for all by the Identity Store application resourceType:String, attributes:List
SchemaAttributesDeletedEvent Attributes are deleted for one of the following resource identity/group/external_account or for all by the Identity Store application resourceType:String, attributes:List
SchemaAttributesUpdatedEvent Attributes are updated for one of the following resource identity/group/external_account or for all by the Identity Store application resourceType:String, attributes:List
UserActivatedEvent User is activated userId:UUID
UserBlockedEvent User is blocked userId:UUID
UserCreatedEvent User is created userId:UUID
UserDeactivatedEvent User is deactivated userId:UUID
UserDeletedEvent User is deleted userId:UUID
UserSignedInEvent User signed in userId:UUID, identityProviderId:String, date:OffsetDateTime, destination:String (This is the name of the service Provider that initiated the authentication request and to which the user will be redirected back, unless the flow is interrupted due to custom logic)
UserSoftDeletedEvent User is soft deleted userId:UUID
UserUnblockedEvent User is unblocked userId:UUID

Model objects

Model object Fields
Address houseNumber:Integer, houseNumberAddition:String, streetName:String, postalCode:String, city:String, region:String, country:String, primary:Boolean, verified:Boolean
AttributeSchemaMetadata id:UUID, name:String, description:String, possibleValues:List, defaultValue:String, value:String
CustomAttribute name:String, value:Object, valueType:CustomAttributeType
CustomAttributeType One of SINGLE, LIST, MAP
EmailAddress value:String, primary:Boolean, verified:Boolean
Gender type:GenderType, customValue:String (Required only for type=OTHER)
GenderType One of MALE, FEMALE, OTHER, UNSPECIFIED
IdentityAttribute id:UUID, name:String, isCustom:Boolean, displayName:String, description:String, possibleValues:List, defaultValue:String, schemaMetadata:List
IdentityAttributeUpdate oldAttribute:IdentityAttribute, newAttribute:IdentityAttribute
IdentityAttributeUpdateValue id:UUID, name:String, oldValue:String, newValue:String
IdentityAttributeValue id:UUID, name:String, value:String
Name givenName:String, familyName:String, displayName:String, initials:String
PhoneNumber value:String, primary:Boolean, verified:Boolean

On this page