OpenMetadata/docs/openmetadata-apis/schemas/entities/user.md

User

This schema defines the User entity. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets.

$id:https://open-metadata.org/schema/entity/teams/user.json

Type: object

This schema does not accept additional properties.

Properties

• id required
  • Unique identifier that identifies a user entity instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • $ref: #/definitions/userName
• description
  • Used for user biography.
  • Type: string
• displayName
  • Name used for display purposes. Example 'FirstName LastName'.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity.
  • $ref: ../../type/basic.json#/definitions/dateTime
• updatedBy
  • User who made the update.
  • Type: string
• email required
  • Email address of the user.
  • $ref: ../../type/basic.json#/definitions/email
• href required
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• timezone
  • Timezone of the user.
  • Type: string
  • String format must be a "timezone"
• deactivated
  • When true indicates the user has been deactivated. Users are deactivated instead of deleted.
  • Type: boolean
  • Default: false
• isBot
  • When true indicates a special type of user called Bot.
  • Type: boolean
• isAdmin
  • When true indicates user is an administrator for the system with superuser privileges.
  • Type: boolean
• profile
  • Profile of the user.
  • $ref: ../../type/profile.json
• teams
  • Teams that the user belongs to.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• owns
  • List of entities owned by the user.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• follows
  • List of entities followed by the user.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription

Type definitions in this schema

userName

• A unique name of the user, typically the user ID from an identity provider. Example - uid from LDAP.
• Type: string
• Length: between 1 and 128

This document was updated on: Tuesday, December 14, 2021