Version: v5.1

Passport Service events

Overview#

In the Notification Service, event triggers are set up which listen to events and determine when to send a notification. This section provides a list of the common events and events which are specific to the Passport Service.

Resource events#

Events are linked to resources. The actual type of the resource is indicated by the resource.type property.

The other properties shown for a given resource depend on the type.

Refer to the event listings later in this section for different services, indicating the resource types and the properties which are available.

Event filtering#

In an event type trigger, filtering on the properties of a incoming event is supported.

An event filter is of the form:

{  "filter": {    <property...>: <wildcard>  }}

For example, to match create events from the Passport Service, the event filter would look like the code listing below.

{  "filter": {    "event": "resource.ResourceCreated",    "resource.type": "passportsvc.*"  }}

List of events#

These sections list the following types of events:

Common events
Passport Service events

List of resource types#

This section lists the following resource types which are specific to the Passport Service:

Passport Service resource types

Common events#

resource.ResourceCreated#

A resource created event is emitted when a resource is created.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceCreated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceUpdated#

A resource updated event is emitted when a resource is changed.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceUpdated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceSoftDeleted#

A resource soft deleted event is emitted if a resource is marked for deletion but not yet permanently deleted.

Typically, a resource.ResourceHardDeleted event will follow a resource.ResourceSoftDeleted event. However, not all services support soft delete and in this case, only a resource.ResourceHardDeleted is emitted.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceSoftDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceHardDeleted#

A resource hard deleted event is emitted if a resource is deleted permanently. This means is it either deleted with ?purge=true or otherwise deleted in a way that means it cannot be recovered.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceHardDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

Passport Service events#

passportsvc.Login#

A login event is emitted when a user logs into the Passport Service. This type of event is only emitted when a login is initiated through a user interface, for example, through a web page. It does not occur for requests that are only authenticated as a particular user.

Property	Type
`uuid`	string
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "passportsvc.Login",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

passportsvc.Logout#

A logout event is emitted when a user logs outs of the Passport Service, for example, by clicking logout in the console.

Property	Type
`uuid`	string
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "passportsvc.Logout",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

Resource types#

Passport Service resource types#

passportsvc.Application#

Property	Type
`id`	string
`namespaces`	string[]
`configs`	map
before/after
`name`	string
`namespaces`	string[]
`configs`	map
`description`	string
`userType`	string
`shortName`	string[]
`appOwner`	string

passportsvc.Namespace#

Property	Type
`id`	string
`namespaces`	string[]
before/after
`namespaces`	string[]

passportsvc.Organization#

Property	Type
`id`	string
`namespaces`	string[]
before/after
`name`	string
`namespaces`	string[]
`description`	string