Skip to content
Stable

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

My Profile API

The My Profile API supports personalization in the open metadata ecosystem. At the heart of personalization is the personal profile that describes an individual with details such as their name, job role and contact details. The personal profile then becomes the parent node where the individual can attach and maintain collections of favourite elements such as assets, projects and links to the profiles of other people in their network. User interfaces, connectors and other services can use this information to provide special service to the individual.

Retrieving the personal profile

This service only has one operation called getMyProfile. It extracts the user identity (aka userId or username) from the bearer token and looks up/returns the personal profile for that user. The returned profile includes all of the caller's existing roles, userIds, contact details and peers associated with the profile. This information supplies the necessary GUIDs to work with other APIs such as Actor Manager, Collection Manager and Asset Maker to build out a rich personal profile.

Setting up a personal profile

If nothing is returned from getMyProfile it means you do not have a personal profile. It is easy to set one up through the Actor Manager API. First you create a Person element that acts as the root of the personal profile. Then you link a UserIdentity element to it for your user identity. When you call getMyProfile, Egeria first looks up the UserIdentity element based on your user identity in the bearer token and then navigates to the Person element.

Notification Inbox

The Notification Inbox is a feature of My Profile OMVS designed to back user interfaces (UIs) that support notification for a specific user.

Each user notification, also known as an action, has a status, summary description and a link to one or more elements that the notification refers to. For example, a notification may indicate that:

  • New data is available for a digital product that the user is watching.
  • A new action for the user has been created.
  • An asynchronous process initiated by the user has finished.

The user can view the details of the notification, change the status of the notification, or delete it.

Raise an issue or comment below