45 lines
1.6 KiB
Markdown
Raw Normal View History

# 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**](https://open-metadata.org/schema/entity/teams/team.json)
Type: `object`
## Properties
* **id** `required`
2021-08-16 05:20:54 +00:00
* $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **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)
* **profile**
* Team profile information.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/profile.json](../types/profile.md)
* **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)
* **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)
## Types definitions in this schema
**teamName**
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.
* Type: `string`
* Length: between 1 and 64