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

Team Entity

team

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json

Team entity

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	team.json

Team entity Type

object [Team entity](team.md)

Team entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Basic type
name	string	Required	cannot be null	Team entity
displayName	string	Optional	cannot be null	Team entity
description	string	Optional	cannot be null	Team entity
href	string	Required	cannot be null	Basic type
profile	object	Optional	cannot be null	Profile type
deleted	boolean	Optional	cannot be null	Team entity
users	array	Optional	cannot be null	Entity Reference type
owns	array	Optional	cannot be null	Entity Reference type

id

Unique id used to identify an entity

id

• is required
• Type: string
• cannot be null
• defined in: Basic type

id Type

string

id Constraints

UUID: the string must be a UUID, according to RFC 4122

name

Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap.

name

• is required
• Type: string
• cannot be null
• defined in: Team entity

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

displayName

Name used for display purposes. Example 'Data Science team'

displayName

• is optional
• Type: string
• cannot be null
• defined in: Team entity

displayName Type

string

description

Description of the team

description

• is optional
• Type: string
• cannot be null
• defined in: Team entity

description Type

string

href

Link to the resource corresponding to this entity

Link to the resource

href

• is required
• Type: string
• cannot be null
• defined in: Basic type

href Type

string

href Constraints

URI: the string must be a URI, according to RFC 3986

profile

Type used to capture profile of a user, team, or an organization

profile

• is optional
• Type: object [Type used to capture profile of a user, team, or an organization](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/profile.md)
• cannot be null
• defined in: Profile type

profile Type

object [Type used to capture profile of a user, team, or an organization](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/profile.md)

deleted

deleted

• is optional
• Type: boolean
• cannot be null
• defined in: Team entity

deleted Type

boolean

users

Users that are part of the team

users

• is optional
• Type: object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

users Type

object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

owns

Entities owned by the team

owns

• is optional
• Type: object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

owns Type

object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

team-defintions-teamname

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/teams/createTeam.json#/properties/name

Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	createTeam.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

team-defintions

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json#/defintions

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	team.json*

defintions Type

unknown

team-properties-deleted

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json#/properties/deleted

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	team.json*

deleted Type

boolean

team-properties-description

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json#/properties/description

Description of the team

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	team.json*

description Type

string

team-properties-displayname

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json#/properties/displayName

Name used for display purposes. Example 'Data Science team'

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	team.json*

displayName Type

string

team-properties-name

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json#/properties/name

Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	team.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1