2021-08-11 17:17:55 +00:00
# User
This schema defines the User entity. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets.
2021-11-13 23:03:20 +05:30
**$id: ** [**https://open-metadata.org/schema/entity/teams/user.json** ](https://open-metadata.org/schema/entity/teams/user.json )
2021-08-11 17:17:55 +00:00
Type: `object`
2021-11-13 23:03:20 +05:30
This schema does not accept additional properties.
2021-08-11 17:17:55 +00:00
## Properties
2021-08-26 13:33:44 +05:30
2021-11-13 23:03:20 +05:30
* **id** `required`
* Unique identifier that identifies a user entity instance.
* $ref: [../../type/basic.json#/definitions/uuid ](../types/basic.md#uuid )
* **name** `required`
* $ref: [#/definitions/userName ](user.md#username )
* **displayName**
* Name used for display purposes. Example 'FirstName LastName'.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion ](../types/basic.md#entityversion )
* **updatedAt**
* Last update time corresponding to the new version of the entity.
* $ref: [../../type/basic.json#/definitions/dateTime ](../types/basic.md#datetime )
* **updatedBy**
* User who made the update.
* Type: `string`
* **email** `required`
* Email address of the user.
* $ref: [../../type/basic.json#/definitions/email ](../types/basic.md#email )
* **href** `required`
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href ](../types/basic.md#href )
* **timezone**
* Timezone of the user.
* Type: `string`
* String format must be a "timezone"
* **deactivated**
* When true indicates the user has been deactivated. Users are deactivated instead of deleted.
* Type: `boolean`
* **isBot**
* When true indicates a special type of user called Bot.
* Type: `boolean`
* **isAdmin**
* When true indicates user is an administrator for the system with superuser privileges.
* Type: `boolean`
* **profile**
* Profile of the user.
* $ref: [../../type/profile.json ](../types/profile.md )
* **teams**
* Teams that the user belongs to.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList ](../types/entityreference.md#entityreferencelist )
* **owns**
* List of entities owned by the user.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList ](../types/entityreference.md#entityreferencelist )
* **follows**
* List of entities followed by the user.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList ](../types/entityreference.md#entityreferencelist )
2021-08-26 13:33:44 +05:30
## Type definitions in this schema
2021-11-13 23:03:20 +05:30
2021-08-29 21:24:50 +00:00
### userName
2021-08-26 13:33:44 +05:30
2021-11-13 23:03:20 +05:30
* A unique name of the user, typically the user ID from an identity provider. Example - uuid from LDAP.
* Type: `string`
* Length: between 1 and 64
2021-09-19 08:43:31 +05:30
2021-11-13 23:03:20 +05:30
_This document was updated on: Monday, October 18, 2021_
