61 lines
2.4 KiB
Markdown
Raw Normal View History

# 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.
**$id:** [**https://open-metadata.org/schema/entity/teams/user.json**](https://open-metadata.org/schema/entity/teams/user.json)
Type: `object`
This schema does not accept additional properties.
## Properties
* **id** `required`
* Unique identifier that identifies a user entity instance.
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/userName](user.md#/definitions/userName)
* **displayName**
* Name used for display purposes. Example 'FirstName LastName'.
* Type: `string`
* **email** `required`
* Email address of the user.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/basic.json\#/definitions/email](../types/basic.md#types-definitions-in-this-schema)
* **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)
* **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.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/profile.json](../types/profile.md)
* **teams**
* Teams that the user belongs to.
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 user.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
* **follows**
* List of entities followed by the user.
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
**userName**
* A unique name of the user typically the user ID from an identity provider. Example - uid from ldap.
* Type: `string`
* Length: between 1 and 64