mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-12 19:48:26 +00:00
2.8 KiB
2.8 KiB
Policy
This schema defines the Policy entity. A Policy defines lifecycle or access control that needs to be applied across different Data Entities.
$id: https://open-metadata.org/schema/entity/policies/policy.json
Type: object
This schema does not accept additional properties.
Properties
- id
required
- Unique identifier that identifies this Policy.
- $ref: ../../type/basic.json#/definitions/uuid
- name
required
- Name that uniquely identifies this Policy.
- $ref: #/definitions/policyName
- fullyQualifiedName
- Name that uniquely identifies a Policy.
- $ref: #/definitions/policyName
- displayName
- Title for this Policy.
- Type:
string
- description
- A short description of the Policy, comprehensible to regular users.
- Type:
string
- owner
- Owner of this Policy.
- $ref: ../../type/entityReference.json
- policyUrl
- Link to a well documented definition of this Policy.
- Type:
string
- String format must be a "uri"
- href
- Link to the resource corresponding to this entity.
- $ref: ../../type/basic.json#/definitions/href
- policyType
required
- $ref: #/definitions/policyType
- enabled
- Is the policy enabled.
- Type:
boolean
- Default: true
- version
- Metadata version of the Policy.
- $ref: ../../type/entityHistory.json#/definitions/entityVersion
- updatedAt
- Last update time corresponding to the new version of the Policy in Unix epoch time milliseconds.
- $ref: ../../type/basic.json#/definitions/timestamp
- updatedBy
- User who made the update.
- Type:
string
- changeDescription
- Change that led to this version of the Policy.
- $ref: ../../type/entityHistory.json#/definitions/changeDescription
- rules
- $ref: #/definitions/rules
- location
- deleted
- When
true
indicates the entity has been soft deleted. - Type:
boolean
- Default: false
- When
Type definitions in this schema
policyName
- Name that identifies this Policy.
- Type:
string
- Length: between 1 and 128
policyType
- This schema defines the type used for describing different types of policies.
- Type:
string
- The value is restricted to the following:
- "AccessControl"
- "Lifecycle"
rules
- A set of rules associated with the Policy.
- Type:
array
- Items
This document was updated on: Wednesday, March 9, 2022