Add custom_attributes field support to User model#110
Merged
Subterrane merged 2 commits intomainfrom Oct 3, 2025
Merged
Conversation
Co-authored-by: Subterrane <5290140+Subterrane@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] custom_attributes not working with UsersV2Api
Add custom_attributes field support to User model
Oct 3, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the custom_attributes field to the User model to resolve an issue where users could not access custom attributes from the UsersV2Api responses despite the data being present in the API response.
- Added
custom_attributesas an optional dictionary field to the User model - Updated serialization/deserialization methods to handle the new field
- Created comprehensive test suite to validate the implementation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| onelogin/models/user.py | Added custom_attributes field with proper type annotations and updated serialization methods |
| docs/User.md | Added documentation for the new custom_attributes field |
| test/test_user_custom_attributes.py | Added comprehensive test suite covering various scenarios for custom_attributes functionality |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
When calling
list_users2()from the UsersV2Api, thecustom_attributesfield was not accessible on the returned User objects, even though the OneLogin API includes this data in responses. Users had to resort to workarounds like:This issue occurred because the
custom_attributesfield was not defined in the User model (onelogin/models/user.py).Solution
Added
custom_attributesas an optional dictionary field to the User model. Custom attributes are dynamic key-value pairs defined per OneLogin account, so they're represented asOptional[Dict[str, Any]].Changes:
custom_attributesfield to the User model with proper type annotations__propertieslist to include the new fieldfrom_dict()to parse custom_attributes from API responsesdocs/User.mdUsage
After this fix, custom attributes are directly accessible:
Testing
Fixes #107
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.