Limiting the Appearance of the Edit Button in DataHub

ui
1

Original Slack Thread

<@U06TM7M40RK> how to I limit the appearance of the edit button

2

It seems likely that limiting the appearance of the edit button in DataHub can be achieved by controlling user permissions and roles. According to the <https://github.com/datahub-project/datahub/blob/master/docs/authorization/roles.md|DataHub documentation on roles>, roles and permissions can be used to manage what actions users can perform, including editing capabilities.

Additionally, based on the <https://github.com/datahub-project/datahub/blob/master/docs/authorization/policies.md|DataHub policies documentation>, you can define specific policies that determine who can edit certain entities. By setting these policies, you can ensure that only users with the appropriate privileges see the edit button.

If you are looking to hide the edit button for users who do not have edit permissions, you might need to implement a check in the UI code to conditionally render the button based on the user’s permissions. For example, in the https://github.com/datahub-project/datahub/blob/master/datahub-web-react/src/app/entityV2/group/GroupProfileInfoCard.tsx|GroupProfileInfoCard.tsx file, there is a check for canEditGroupName which determines if the edit button should be shown.

Would you like more detailed steps or specific examples on how to implement this in the UI code?

Sources:

3

Hi <@U08AER1JC7Q>, how did my answer work out for you? Need any more assistance? You can also tag <@U07FV3UHE4D> to let your fellow community members know you’re still looking for guidance.

4

<@U06TM7M40RK> you answered my question but a more detailed example would be better. Do you have an api so I can pull your information and combine with Claude?

5

To provide a more detailed example of how to limit the appearance of the edit button in DataHub, you can follow these steps:

  1. Understand User Roles and Permissions: DataHub uses roles and permissions to control access to various features. You can define roles such as Admin, Editor, and Reader, each with different levels of access. For example, only users with the Admin or Editor role might have the permission to edit entities.

  2. Define Policies: Use DataHub’s policy framework to define who can perform edit operations. According to the <https://github.com/datahub-project/datahub/blob/master/docs/authorization/policies.md|DataHub policies documentation>, you can create custom policies that specify which users or groups have edit permissions.

  3. Modify UI Code: In the UI code, you can conditionally render the edit button based on the user’s permissions. For example, in a React component, you might have a check like this:

    import React from 'react';

const EditButton = ({ userPermissions }) => {
  const canEdit = userPermissions.includes('EDIT_ENTITY');

  return (
    <div>
      {canEdit && <button>Edit</button>}
    </div>
  );
};

export default EditButton;

    In this example, the EditButton component checks if the userPermissions array includes the EDIT_ENTITY permission. If it does, the edit button is rendered.

  4. Use GraphQL API for Permissions: You can use the <https://github.com/datahub-project/datahub/blob/master/docs/api/graphql/overview.md|DataHub GraphQL API> to fetch user permissions programmatically. This allows you to dynamically determine which buttons to display based on the user’s current permissions.

    Here’s a basic example of how you might query user permissions using GraphQL:

    query GetUserPermissions($userId: ID!) {
  user(id: $userId) {
    permissions {
      name
    }
  }
}

    You can then use the result of this query to determine whether to show the edit button.

  5. Combine with Other Tools: If you want to integrate this with other tools like Claude, you can use the API to fetch data and then process it with your chosen tool. However, DataHub does not provide a direct API for integration with Claude.

Would you like more information on any specific part of this process?

Sources: