Add a new field to the profile table

Oct 13, 2025 by recoveryshake.com 125 views

Introduction

In an effort to maintain a secure and compliant environment, it is essential to implement measures that restrict access to sensitive features, such as signing the Contributor License Agreement (CLA). This article outlines the necessary steps to block users from signing the ICLA/ECLA if they are identified as being from a restricted country or organization.

Access Restricted

If a user is blocked from signing the ICLA/ECLA, they will be presented with the following message:

Access Restricted

We’re sorry, but you are currently unable to sign the Contributor License Agreement (CLA).

If you believe this may be an error, please don’t hesitate to reach out to our support team at [Support Email/Link]. We’ll be happy to review your case and provide assistance.

Thank you for your understanding and cooperation.

Implementation Instructions: Backend and Frontend

Backend (BE)

To implement the restriction on ICLA/ECLA signing, we need to make changes to both the database and the API.

Database Update

Add a new field to the profile table: eligible_to_contribute (or a similar name).
Default to NULL for existing users: The new field should have a default value of NULL for existing users.
Manually set to FALSE if a user is identified as ineligible to contribute: The field should be manually set to FALSE if a user is identified as ineligible to contribute.

API Update

Create a new API endpoint (or extend an existing one): to expose the value of eligible_to_contribute for a given user.
API logic:
- If eligible_to_contribute is explicitly set to FALSE, the API should return FALSE.
- For all other cases (e.g., NULL or not set), the API should return TRUE by default.

Testing

Ensure the new API endpoint/extension is secure: and returns the correct value based on the field’s state.

Frontend (FE)

Before showing the "Compliance Checkbox", we need to make an API call to get the value for eligible_to_contribute. If it is FALSE, then we show the "Access Restricted" message above. If it is TRUE, then we show the "Compliance Checkbox" as usual.

Implementation Steps

Make an API call: to get the value of eligible_to_contribute for the current user.
Check the response: If the response is FALSE, show the "Access Restricted" message.
Show the "Compliance Checkbox": if the response is TRUE.

Benefits of Restricting ICLA/ECLA Signing

Restricting ICLA/ECLA signing for blocked users provides several benefits, including:

Improved security: By restricting access to sensitive features, we can reduce the risk of unauthorized access and data breaches.
Enhanced compliance: By implementing measures to restrict access to sensitive features, we can ensure compliance with relevant regulations and standards.
Better user experience: By providing clear and concise messages to users, we can improve their overall experience and reduce confusion.

Conclusion

Introduction

In our previous article, we discussed the importance of restricting ICLA/ECLA signing for blocked users and outlined the necessary steps to implement this feature. In this article, we will address some frequently asked questions (FAQs) related to this topic.

Q: Why is it necessary to restrict ICLA/ECLA signing for blocked users?

A: Restricting ICLA/ECLA signing for blocked users is essential to maintain a secure and compliant environment. By restricting access to sensitive features, we can reduce the risk of unauthorized access and data breaches, and ensure compliance with relevant regulations and standards.

Q: How do I identify blocked users?

A: Blocked users can be identified based on various criteria, such as their country of origin, organization, or other relevant factors. You can use a combination of manual and automated methods to identify blocked users and update their profile accordingly.

Q: What is the eligible_to_contribute field, and how is it used?

A: The eligible_to_contribute field is a new field added to the profile table to track a user's eligibility to contribute. This field is set to FALSE if a user is identified as ineligible to contribute, and TRUE otherwise. The API uses this field to determine whether a user is eligible to sign the ICLA/ECLA.

Q: How do I update the eligible_to_contribute field for a user?

A: You can update the eligible_to_contribute field for a user manually by setting it to FALSE if the user is identified as ineligible to contribute. You can also use automated methods to update this field based on various criteria.

Q: What is the API endpoint for retrieving the eligible_to_contribute value?

A: The API endpoint for retrieving the eligible_to_contribute value is a new endpoint that exposes the value of this field for a given user. You can use this endpoint to determine whether a user is eligible to sign the ICLA/ECLA.

Q: How do I handle cases where the eligible_to_contribute field is NULL or not set?

A: In cases where the eligible_to_contribute field is NULL or not set, the API should return TRUE by default. This ensures that users who are not explicitly blocked are still eligible to sign the ICLA/ECLA.

Q: Can I customize the "Access Restricted" message for blocked users?

A: Yes, you can customize the "Access Restricted" message for blocked users to provide a clear and concise explanation of the reason for the restriction.

Q: How do I test the new API endpoint and implementation?

A: You can test the new API endpoint and implementation by making API calls to retrieve the eligible_to_contribute value for various users and verifying the response. You can also use automated testing tools to ensure that the implementation is correct and secure.

Conclusion

In conclusion, restricting ICLA/ECLA signing for blocked users is a critical step in maintaining a secure and compliant environment. By addressing the FAQs related to this topic, we can ensure that our implementation is correct, secure, and meets the needs of our users.