OpenMetadata/docs/openmetadata-apis/schemas/entities/user.md

User entity

user

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json

User entity that is part of an organization

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	Yes	Unknown status	No	Forbidden	Allowed	none	user.json

User entity Type

object [User entity](user.md)

User entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Basic type
name	string	Required	cannot be null	User entity
displayName	string	Optional	cannot be null	User entity
email	string	Required	cannot be null	Basic type
href	string	Required	cannot be null	Basic type
timezone	string	Optional	cannot be null	User entity
deactivated	boolean	Optional	cannot be null	User entity
isBot	boolean	Optional	cannot be null	User entity
isAdmin	boolean	Optional	cannot be null	User entity
profile	object	Optional	cannot be null	Profile type
teams	array	Optional	cannot be null	Entity Reference type
owns	array	Optional	cannot be null	Entity Reference type
follows	array	Optional	cannot be null	Entity Reference type

id

Unique id used to identify an entity

id

• is required
• Type: string
• cannot be null
• defined in: Basic type

id Type

string

id Constraints

UUID: the string must be a UUID, according to RFC 4122

name

Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.

name

• is required
• Type: string
• cannot be null
• defined in: User entity

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

displayName

Name used for display purposes. Example 'FirstName LastName'

displayName

• is optional
• Type: string
• cannot be null
• defined in: User entity

displayName Type

string

email

Email address of user or other entities

email

• is required
• Type: string
• cannot be null
• defined in: Basic type

email Type

string

email Constraints

maximum length: the maximum number of characters for this string is: 127

minimum length: the minimum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^\S+@\S+\.\S+$

try pattern

email: the string must be an email address, according to RFC 5322, section 3.4.1

href

Link to the resource corresponding to this entity

Link to the resource

href

• is required
• Type: string
• cannot be null
• defined in: Basic type

href Type

string

href Constraints

URI: the string must be a URI, according to RFC 3986

timezone

Timezone of the user

timezone

• is optional
• Type: string
• cannot be null
• defined in: User entity

timezone Type

string

timezone Constraints

unknown format: the value of this string must follow the format: timezone

deactivated

deactivated

• is optional
• Type: boolean
• cannot be null
• defined in: User entity

deactivated Type

boolean

isBot

isBot

• is optional
• Type: boolean
• cannot be null
• defined in: User entity

isBot Type

boolean

isAdmin

When true indicates user is an adiministrator for the sytem with superuser privileges

isAdmin

• is optional
• Type: boolean
• cannot be null
• defined in: User entity

isAdmin Type

boolean

profile

Type used to capture profile of a user, team, or an organization

profile

• is optional
• Type: object [Type used to capture profile of a user, team, or an organization](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/profile.md)
• cannot be null
• defined in: Profile type

profile Type

object [Type used to capture profile of a user, team, or an organization](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/profile.md)

teams

Teams that the user belongs to

teams

• is optional
• Type: object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

teams Type

object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

owns

Entities owned by the user

owns

• is optional
• Type: object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

owns Type

object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

follows

Entities followed by the user

follows

• is optional
• Type: object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

follows Type

object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

User entity Definitions

Definitions group userName

Reference this group by using

{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/definitions/userName"}

Property	Type	Required	Nullable	Defined by

user-definitions-username

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json#/properties/name

Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	createUser.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

user-definitions

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/definitions

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

definitions Type

unknown

user-properties-deactivated

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/properties/deactivated

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

deactivated Type

boolean

user-properties-displayname

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/properties/displayName

Name used for display purposes. Example 'FirstName LastName'

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

displayName Type

string

user-properties-isadmin

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/properties/isAdmin

When true indicates user is an adiministrator for the sytem with superuser privileges

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

isAdmin Type

boolean

user-properties-isbot

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/properties/isBot

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

isBot Type

boolean

user-properties-name

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/properties/name

Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

user-properties-timezone

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json#/properties/timezone

Timezone of the user

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	user.json*

timezone Type

string

timezone Constraints

unknown format: the value of this string must follow the format: timezone