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 15:48:38 +00:00
|
|
|
**$id:** [**https://open-metadata.org/schema/entity/teams/team.json**](https://open-metadata.org/schema/entity/teams/team.json)
|
2021-08-11 17:17:55 +00:00
|
|
|
|
|
|
|
Type: `object`
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2021-08-13 15:48:38 +00:00
|
|
|
* **id** `required`
|
2021-08-16 05:20:54 +00:00
|
|
|
* $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
|
2021-08-13 15:48:38 +00:00
|
|
|
* **name** `required`
|
|
|
|
* $ref: [\#/definitions/teamName](team.md#/definitions/teamName)
|
|
|
|
* **displayName**
|
|
|
|
* Name used for display purposes. Example 'Data Science team'.
|
|
|
|
* Type: `string`
|
|
|
|
* **description**
|
|
|
|
* Description of the team.
|
|
|
|
* Type: `string`
|
|
|
|
* **href** `required`
|
|
|
|
* Link to the resource corresponding to this entity.
|
2021-08-16 05:20:54 +00:00
|
|
|
* $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
|
2021-08-13 15:48:38 +00:00
|
|
|
* **profile**
|
|
|
|
* Team profile information.
|
2021-08-16 05:20:54 +00:00
|
|
|
* $ref: [../../type/profile.json](../types/profile.md)
|
2021-08-13 15:48:38 +00:00
|
|
|
* **deleted**
|
|
|
|
* When true the team has been deleted.
|
|
|
|
* Type: `boolean`
|
|
|
|
* **users**
|
|
|
|
* Users that are part of the team.
|
2021-08-16 05:20:54 +00:00
|
|
|
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
|
2021-08-13 15:48:38 +00:00
|
|
|
* **owns**
|
|
|
|
* List of entities owned by the team.
|
2021-08-16 05:20:54 +00:00
|
|
|
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
|
2021-08-11 17:17:55 +00:00
|
|
|
|
|
|
|
## Types definitions in this schema
|
|
|
|
|
2021-08-13 15:48:38 +00:00
|
|
|
**teamName**
|
2021-08-13 08:26:20 -07:00
|
|
|
|
2021-08-16 16:28:10 +00:00
|
|
|
* A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.
|
2021-08-13 15:48:38 +00:00
|
|
|
* Type: `string`
|
|
|
|
* Length: between 1 and 64
|
2021-08-11 17:17:55 +00:00
|
|
|
|