[PM-12777] Fixed Issue #4034, API endpoint now handles optional parameters

[BensonB12]

🎟️ Tracking

#4034

📔 Objective

The API endpoint: 'https://scim.bitwarden.com/v2/{Tenant-ID}/Users' now accepts null values for 'count' and 'startingIndex'. It now has a default value of count 50 and startingIndex 1. We made an integration test (based on a previously made one) that now tests that function.

User: https:/dougedey-sf said that this new function is the wanted behavior. We did not double check that, but we did notice that https:/cbbit commented without contradicting the issue.

🦮 Reviewer guidelines

• 👍 (:+1:) or similar for great changes
• 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
• ❓ (:question:) for questions
• 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
• 🎨 (:art:) for suggestions / improvements
• ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
• 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
• ⛏ (:pick:) for minor or nitpick changes

[bitwarden-bot]

Thank you for your contribution! We've added this to our internal Community PR board for review.
ID: PM-12777

[jrmccannon]

First off, thank you for contributing to Bitwarden. This is a good initial pass and thank you for including a test. To improve on this, you could maybe add a new request object that uses some data annotations that limits the values that could be passed in to that endpoint. You can then provide that object as a parameter in UserController#Get with the [FromQuery] attribute.

That class could look something like

public class GetUsersQueryParam
{
        public string Filter { get; init; } = string.Empty;

        [Range(1, int.MaxValue)]
        public int Count { get; init; } = 50;

        [Range(1, int.MaxValue)]
        public int StartIndex { get; init; } = 1;
}

This would provide callers with helpful error messages in the event they accidentally provide invalid values. Then you could refactor the method signature and syntax of GetUsersListQuery#GetUserListAsync() to takeints rather than int?s.

Thanks again!

[github-actions]

Checkmarx One – Scan Summary & Details – 94a429b9-ace1-4c1a-9736-7fe1eb1cfbe0

No New Or Fixed Issues Found

[jrmccannon]

Sorry for the delay. This has passed through QA and will be included in the 2024.10.1 release. Thank you again for your contribution.