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

AccessControlRule

Describes an Access Control Rule for OpenMetadata Metadata Operations. All non-null user (subject) and entity (object) attributes are evaluated with logical AND.

$id: https://open-metadata.org/schema/entity/data/policies/accessControl/rule.json

Type: object

This schema does not accept additional properties.

Properties

• name required
  • Name for this Rule.
  • Type: string
• entityTypeAttr
  • Entity type that the rule should match on.
  • Type: string
• entityTagAttr
  • Entity tag that the rule should match on.
  • $ref: ../../type/tagLabel.json#/definitions/tagFQN
• userRoleAttr
  • Role of the user that the rule should match on.
  • $ref: ../teams/role.json#/definitions/roleName
• operation
  • Operation on the entity.
  • $ref: #/definitions/operation
• allow
  • Allow or Deny operation on the entity.
  • Type: boolean
  • Default: false
• priority
  • Priority of this rule among all rules across all policies.
  • Type: integer
  • Default: 250000
• enabled
  • Is the rule enabled.
  • Type: boolean
  • Default: true

Type definitions in this schema

operation

• This schema defines all possible operations on metadata of data entities.
• Type: string
• The value is restricted to the following:
  1. "SuggestDescription"
  2. "SuggestTags"
  3. "UpdateDescription"
  4. "UpdateOwner"
  5. "UpdateTags"
  6. "UpdateLineage"
  7. "DecryptTokens"
  8. "UpdateTeam"

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