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

Role

This schema defines the Role entity. A Role has access to zero or more data assets.

$id: https://open-metadata.org/schema/entity/teams/role.json

Type: object

This schema does not accept additional properties.

Properties

• id required
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • $ref: #/definitions/roleName
• displayName
  • Name used for display purposes. Example 'Data Consumer'.
  • Type: string
• description
  • Description of the role.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false
• policy
  • Policy that is attached to this role.
  • $ref: ../../type/entityReference.json
• users
  • Users that have this role assigned.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• defaultRole
  • If true, this role is set as default role and will be assigned to all users.
  • Type: boolean
  • Default: false
• teams
  • Teams that have this role assigned.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList

Type definitions in this schema

roleName

• A unique name for the role.
• Type: string
• Length: between 1 and 128

This document was updated on: Wednesday, March 9, 2022