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

Team

This schema defines the Team entity. A Team is a group of zero or more users. Teams can own zero or more data assets.

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

Type: object

This schema does not accept additional properties.

Properties

• id required
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • $ref: #/definitions/teamName
• displayName
  • Name used for display purposes. Example 'Data Science team'.
  • Type: string
• description
  • Description of the team.
  • 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 in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href required
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• profile
  • Team profile information.
  • $ref: ../../type/profile.json
• users
  • Users that are part of the team.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• owns
  • List of entities owned by the team.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false
• defaultRoles
  • Roles to be assigned to all users that are part of this team.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList

Type definitions in this schema

teamName

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

This document was updated on: Monday, March 7, 2022