yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-30 01:59:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.6.x-SNAPSHOT/main-concepts/metadata-standard/schemas/entity/policies/policy.md
Pere Miquel Brull 60ed221cf1
DOCS - Update Version Snapshots (#17589)
2024-08-27 14:41:12 +05:30

2.6 KiB
Raw Blame History

title slug
policy /main-concepts/metadata-standard/schemas/entity/policies/policy

Policy

A Policy defines control that needs to be applied across different Data Entities.

Properties

  • id: Unique identifier that identifies this Policy. Refer to ../../type/basic.json#/definitions/uuid.
  • name: Name that uniquely identifies this Policy. Refer to ../../type/basic.json#/definitions/entityName.
  • fullyQualifiedName: Name that uniquely identifies a Policy. Refer to ../../type/basic.json#/definitions/entityName.
  • displayName (string): Display name for this Policy.
  • description: A short description of the Policy, comprehensible to regular users. Refer to ../../type/basic.json#/definitions/markdown.
  • owner: Owner of this Policy. Refer to ../../type/entityReference.json. Default: None.
  • href: Link to the resource corresponding to this entity. Refer to ../../type/basic.json#/definitions/href.
  • enabled (boolean): Is the policy enabled. Default: True.
  • version: Metadata version of the Policy. Refer to ../../type/entityHistory.json#/definitions/entityVersion.
  • updatedAt: Last update time corresponding to the new version of the Policy in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.
  • updatedBy (string): User who made the update.
  • changeDescription: Change that led to this version of the Policy. Refer to ../../type/entityHistory.json#/definitions/changeDescription.
  • rules: Set of rules that the policy contains. Refer to #/definitions/rules.
  • teams: Teams that use this policy directly and not through roles. Refer to ../../type/entityReferenceList.json.
  • roles: Roles that use this policy. Refer to ../../type/entityReferenceList.json.
  • location: Location to which a policy is applied. This field is relevant only for lifeCycle policies. Refer to ../../type/entityReference.json. Default: None.
  • allowDelete (boolean): Some system policies can't be deleted.
  • allowEdit (boolean): Some system roles can't be edited.
  • deleted (boolean): When true indicates the entity has been soft deleted. Default: False.
  • provider: Refer to ../../type/basic.json#/definitions/providerType.
  • disabled (boolean): System policy can't be deleted. Use this flag to disable them.

Definitions

  • rules (array): A set of rules associated with the Policy.
    • Items: Refer to accessControl/rule.json.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.