2021-08-11 17:17:55 +00:00
|
|
|
# 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.
|
|
|
|
|
|
2021-08-13 08:26:20 -07:00
|
|
|
<b id="httpsopen-metadata.orgschemaentityteamsteam.json">$id: https://open-metadata.org/schema/entity/teams/team.json</b>
|
2021-08-11 17:17:55 +00:00
|
|
|
|
|
|
|
|
Type: `object`
|
|
|
|
|
|
|
|
|
|
## Properties
|
2021-08-13 08:26:20 -07:00
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/id">id</b> `required`
|
|
|
|
|
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/name">name</b> `required`
|
|
|
|
|
- $ref: [#/definitions/teamName](#/definitions/teamName)
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/displayName">displayName</b>
|
|
|
|
|
- Name used for display purposes. Example 'Data Science team'.
|
|
|
|
|
- Type: `string`
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/description">description</b>
|
|
|
|
|
- Description of the team.
|
|
|
|
|
- Type: `string`
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/href">href</b> `required`
|
|
|
|
|
- Link to the resource corresponding to this entity.
|
|
|
|
|
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/profile">profile</b>
|
|
|
|
|
- Team profile information.
|
|
|
|
|
- $ref: [../../type/profile.json](#....typeprofile.json)
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/deleted">deleted</b>
|
|
|
|
|
- When true the team has been deleted.
|
|
|
|
|
- Type: `boolean`
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/users">users</b>
|
|
|
|
|
- Users that are part of the team.
|
|
|
|
|
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
|
|
|
|
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/owns">owns</b>
|
|
|
|
|
- List of entities owned by the team.
|
|
|
|
|
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
2021-08-11 17:17:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Types definitions in this schema
|
|
|
|
|
**teamName**
|
|
|
|
|
|
2021-08-13 08:26:20 -07:00
|
|
|
- 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 64
|
|
|
|
|
|
2021-08-11 17:17:55 +00:00
|
|
|
|
