Docs: RBAC Search Doc Updated (#20378)

This commit is contained in:
Rounak Dhillon 2025-03-21 14:26:28 +05:30 committed by GitHub
parent aca5956ab6
commit 1045d06194
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 52 additions and 0 deletions

View File

@ -133,6 +133,32 @@ Roles provide the advantage of bundling multiple policies encapsulating a user
Moreover, roles can be allocated either to individual users or teams within an organizational hierarchy. When a role is assigned to a team, every member of that team inherits the privileges of that role. This design is intentional, aiming to simplify the role assignment process for administrators.
## Roles Based Access Controls (RBAC) Search
In OpenMetadata, Role-Based Access Control (RBAC) extends to search functionalities, allowing administrators to enforce granular permissions on metadata assets. By default, the search feature permits all users to access and view available data assets. To restrict search results based on user roles and policies, administrators must enable the Search RBAC setting.
To enable or disable the **RBAC Search** option, navigate to **Settings > Preferences > Search** in the OpenMetadata UI. This setting controls whether search results are filtered based on the user's assigned roles and permissions.
{% image
src="/images/v1.6/how-to-guides/roles-policies/rbac-search.png"
alt="Roles Based Access Controls (RBAC) Search Option"
caption="Roles Based Access Controls (RBAC) Search Option"
/%}
### Implications of Enabling Search RBAC:
**Restricted Search Results**: Users will only see search results for data assets they have explicit permissions to access, enhancing data security and compliance.
**Policy Enforcement**: The system will enforce policies at the search level, ensuring that unauthorized users cannot discover or access sensitive metadata.
### Additional Considerations:
**Role and Policy Configuration**: Ensure that roles and policies are appropriately configured to reflect the desired access controls. This includes assigning correct permissions to users and teams for various data assets.
**Testing**: After enabling Search RBAC, conduct thorough testing to verify that users can access only the data assets permitted by their roles and policies.
For a comprehensive understanding of configuring roles and policies, refer to the [Advanced Guide for Roles and Policies](/how-to-guides/admin-guide/roles-policies/overview). Implementing Search RBAC ensures that OpenMetadata's search functionality aligns with your organization's data governance and security requirements.
{%inlineCallout
color="violet-70"
bold="Use Cases: Creating Roles & Policies in OpenMetadata"

View File

@ -133,6 +133,32 @@ Roles provide the advantage of bundling multiple policies encapsulating a user
Moreover, roles can be allocated either to individual users or teams within an organizational hierarchy. When a role is assigned to a team, every member of that team inherits the privileges of that role. This design is intentional, aiming to simplify the role assignment process for administrators.
## Roles Based Access Controls (RBAC) Search
In OpenMetadata, Role-Based Access Control (RBAC) extends to search functionalities, allowing administrators to enforce granular permissions on metadata assets. By default, the search feature permits all users to access and view available data assets. To restrict search results based on user roles and policies, administrators must enable the Search RBAC setting.
To enable or disable the **RBAC Search** option, navigate to **Settings > Preferences > Search** in the OpenMetadata UI. This setting controls whether search results are filtered based on the user's assigned roles and permissions.
{% image
src="/images/v1.7/how-to-guides/roles-policies/rbac-search.png"
alt="Roles Based Access Controls (RBAC) Search Option"
caption="Roles Based Access Controls (RBAC) Search Option"
/%}
### Implications of Enabling Search RBAC:
**Restricted Search Results**: Users will only see search results for data assets they have explicit permissions to access, enhancing data security and compliance.
**Policy Enforcement**: The system will enforce policies at the search level, ensuring that unauthorized users cannot discover or access sensitive metadata.
### Additional Considerations:
**Role and Policy Configuration**: Ensure that roles and policies are appropriately configured to reflect the desired access controls. This includes assigning correct permissions to users and teams for various data assets.
**Testing**: After enabling Search RBAC, conduct thorough testing to verify that users can access only the data assets permitted by their roles and policies.
For a comprehensive understanding of configuring roles and policies, refer to the [Advanced Guide for Roles and Policies](/how-to-guides/admin-guide/roles-policies/overview). Implementing Search RBAC ensures that OpenMetadata's search functionality aligns with your organization's data governance and security requirements.
{%inlineCallout
color="violet-70"
bold="Use Cases: Creating Roles & Policies in OpenMetadata"

Binary file not shown.

After

Width:  |  Height:  |  Size: 202 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 202 KiB