mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-30 01:59:23 +00:00
62 lines
4.7 KiB
Markdown
62 lines
4.7 KiB
Markdown
|
# User
|
||
|
|
|
||
|
|
This schema defines 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 and own zero or more data asset entities. A user can also follow zero or more data asset entities.
|
||
|
|
|
||
|
|
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentityteamsuser.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json</b>
|
||
|
|
|
||
|
|
Type: `object`
|
||
|
|
|
||
|
|
This schema <u>does not</u> accept additional properties.
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/id">id</b> `required`
|
||
|
|
- Unique identifier that identifies a user entity instance.
|
||
|
|
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/name">name</b> `required`
|
||
|
|
- $ref: [#/definitions/userName](#/definitions/userName)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/displayName">displayName</b>
|
||
|
|
- Name used for display purposes. Example 'FirstName LastName'.
|
||
|
|
- Type: `string`
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/email">email</b> `required`
|
||
|
|
- Email address of the user.
|
||
|
|
- $ref: [../../type/basic.json#/definitions/email](#....typebasic.jsondefinitionsemail)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/href">href</b> `required`
|
||
|
|
- Link to the resource corresponding to this entity.
|
||
|
|
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/timezone">timezone</b>
|
||
|
|
- Timezone of the user.
|
||
|
|
- Type: `string`
|
||
|
|
- String format must be a "timezone"
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/deactivated">deactivated</b>
|
||
|
|
- When true indicates user has been deactivated. Users are deactivated instead of deleted.
|
||
|
|
- Type: `boolean`
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/isBot">isBot</b>
|
||
|
|
- When true indicates a special type of user called Bot.
|
||
|
|
- Type: `boolean`
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/isAdmin">isAdmin</b>
|
||
|
|
- When true indicates user is an administrator for the system with superuser privileges.
|
||
|
|
- Type: `boolean`
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/profile">profile</b>
|
||
|
|
- Profile of the user.
|
||
|
|
- $ref: [../../type/profile.json](#....typeprofile.json)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/teams">teams</b>
|
||
|
|
- Teams that the user belongs to.
|
||
|
|
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/owns">owns</b>
|
||
|
|
- List of entities owned by the user.
|
||
|
|
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||
|
|
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/follows">follows</b>
|
||
|
|
- List of entities followed by the user.
|
||
|
|
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||
|
|
|
||
|
|
|
||
|
|
## Definitions
|
||
|
|
**_userName_**
|
||
|
|
|
||
|
|
- Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.
|
||
|
|
- Type: `string`
|
||
|
|
- Length: between 1 and 64
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 18:41:36 GMT-0700 (Pacific Daylight Time)_
|