Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt

Use this file to discover all available pages before exploring further.

​
module role_policy_mixin

Mixin class containing Role and Policy specific methods To be used by OpenMetadata class

​
class OMetaRolePolicyMixin

OpenMetadata API methods related to Roles and Policies. To be inherited by OpenMetadata

​
method patch_policy_rule

patch_policy_rule(
    entity_id: Union[str, Uuid],
    rule: Optional[Rule] = None,
    operation: Union[ForwardRef(<ADD: 'add'>), ForwardRef(<REMOVE: 'remove'>)] = <PatchOperation.ADD: 'add'>
) → Optional[Policy]
Given a Policy ID, JSON PATCH the rule (add or remove). Args entity_id: ID of the role to be patched rule: The rule to add or remove operation: The operation to perform, either “add” or “remove” Returns Updated Entity

​
method patch_role_policy

patch_role_policy(
    entity_id: Union[str, Uuid],
    policy_id: Union[str, Uuid],
    operation: Union[ForwardRef(<ADD: 'add'>), ForwardRef(<REMOVE: 'remove'>)] = <PatchOperation.ADD: 'add'>
) → Optional[Role]
Given a Role ID, JSON PATCH the policies. Args entity_id: ID of the role to be patched policy_id: ID of the policy to be added or removed operation: Operation to be performed. Either ‘add’ or ‘remove’ Returns Updated Entity