diff --git a/site/docs/concepts/actor.md b/site/docs/concepts/actor.md new file mode 100644 index 0000000000..7e2ba4241b --- /dev/null +++ b/site/docs/concepts/actor.md @@ -0,0 +1,17 @@ +--- +hide: +- toc +--- + + + + +# Actor + +An *actor* is a person, group of people, or an automated process that is operating in the open metadata ecosystem. There are three types of actor: + +* An *Actor Profile* describes a person, team or automated process operating in the open metadata ecosystem. +* An *Actor Role* describes a collection of responsibilities in the open metadata ecosystem. An actor profile can be *appointed* to a role to show that he/she/they/it are performing those responsibilities. +* A *User Identity* describes a user account that is defined to a user account. A user account can be linked to an actor profile to provide information on who/what is using the user account. + +--8<-- "snippets/abbr.md" diff --git a/site/docs/concepts/index.md b/site/docs/concepts/index.md index e7c01857f8..d2159dfd02 100644 --- a/site/docs/concepts/index.md +++ b/site/docs/concepts/index.md @@ -6,7 +6,9 @@ ## A +- [Action](/concepts/action) - [Action Target](/concepts/action-target) +- [Actor](/concepts/actor) - [Analytics Integrator OMIS](/services/omis/analytics-integrator/overview) - [Anchor](/concepts/anchor) - [Anchor Grouping](/concepts/anchor) diff --git a/site/docs/types/1/0110-Actors.md b/site/docs/types/1/0110-Actors.md index 2a5ff99b99..c523a2cee2 100644 --- a/site/docs/types/1/0110-Actors.md +++ b/site/docs/types/1/0110-Actors.md @@ -3,11 +3,11 @@ # 0110 Actors -*Actors* are the people, teams or machines that drive activity in the organization's landscape. +[*Actors*](/concepts/actor) are the people, teams or machines that drive activity in the organization's landscape. ![UML](0110-Actors.svg "Collecting information about user identities and the people and systems behind them") -## ActorProfile +## ActorProfile entity An `ActorProfile` describes an entity to store and link information about an actor in open metadata. It inherits from [`Referenceable`](/types/0/0010-Base-Model) so it has a unique name. @@ -21,11 +21,11 @@ The subtypes of *ActorProfile* add further information about actors: - [Team](/types/1/0115-Teams) for profiles describing teams. - [ITProfile](/types/1/0117-IT-Profiles) for profiles describing specific IT processes and systems. -## ProfileLocation +## ProfileLocation relationship The `ProfileLocation` relationship identifies an association between an ActorProfile and a [Location](/types/0/0025-Locations), such as a person's primary work location. The `associationType` property records the purpose of the association. Its value can be defined in a [ValidValueSet](/types/5/0545-Reference-Data). -## ContactDetails +## ContactDetails entity `ContactDetails` describe the mechanisms to contact an actor - this is typically linked to actor profiles for people and teams. @@ -42,7 +42,7 @@ The `ProfileLocation` relationship identifies an association between an ActorPro - `contactMethodValue` - the address or account name or number to use for this contact method. -## UserIdentity +## UserIdentity entity Most metadata repositories are run in a secure mode requiring incoming requests to include the requester’s security credentials. Therefore, we have an identifier for each unique logged on security identity (aka userId). This identity is recorded in the header of the metadata elements when they are created or updated. @@ -50,7 +50,7 @@ Most metadata repositories are run in a secure mode requiring incoming requests - `distinguishedName` - the fully qualified name in LDAP. -## ProfileIdentity +## ProfileIdentity relationship `ProfileIdentity` links the `ActorProfile` to one or more `UserIdentity` entities. This allows the calling user's profile to be retrieved from the incoming userId. The attributes for `ProfileIdentity` help to pick the right `UserIdentity` based on [`PersonRole`](/types/1/0112-People) when navigating from the `ActorProfile` to multiple `UserIdentity` entities: diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 9e6181d905..53ddab2a7d 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -668,6 +668,7 @@ nav: - Basic Concepts: concepts/basic-concepts.md - Action: concepts/action.md - Action Target: concepts/action-target.md + - Actor: concepts/actor.md - Anchor: concepts/anchor.md - Asset: concepts/asset.md - Asset Log Message: concepts/asset-log-message.md