[API Proposal]: Adding a generic version of `FindByIdentity`
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- csharp
- Domain
- api, backend-api-design
Research direction
Start by locating Principal.FindByIdentity, the protected FindByIdentityWithType implementation, and the ComputerPrincipal, GroupPrincipal, and UserPrincipal declarations. Compare the proposed generic overloads with the existing API surface and determine the compatibility and validation requirements; done means the proposal is implemented consistently and the shown generic usage works.
Written by the indexing model from the issue text.
Description
Background and motivation
There is currently no way to use FindByIdentity in a generic way. There is a protected function FindByIdentityWithType, but this is not accessible from "outside".
We have functions that have to call FindByIdentity with different derived Principal classes. This currently causes us to call FindByIdentity as follows:
var result = typeof(T).GetMethod(nameof(Principal.FindByIdentity), [typeof(PrincipalContext), typeof(IdentityType), typeof(string)])?.Invoke(null, [adPrincipalContext, identityType, identityValue]) as T;
I think that due to the existence of FindByIdentityWithType, the implementation should also be straightforward and should not cause any problems.
API Proposal
namespace System.DirectoryServices.AccountManagement;
public abstract partial class Principal : System.IDisposable
{
public static new T FindByIdentity<T>(PrincipalContext context, string identityValue) where T : Principal
public static new T FindByIdentity<T>(PrincipalContext context, IdentityType identityType, string identityValue) where T : Principal
}
public partial class ComputerPrincipal : System.DirectoryServices.AccountManagement.AuthenticablePrincipal
{
public static new T FindByIdentity<T>(PrincipalContext context, string identityValue) where T : ComputerPrincipal
public static new T FindByIdentity<T>(PrincipalContext context, IdentityType identityType, string identityValue) where T : ComputerPrincipal
}
public partial class GroupPrincipal : System.DirectoryServices.AccountManagement.Principal
{
public static new T FindByIdentity<T>(PrincipalContext context, string identityValue) where T : GroupPrincipal
public static new T FindByIdentity<T>(PrincipalContext context, IdentityType identityType, string identityValue) where T : GroupPrincipal
}
public partial class UserPrincipal : System.DirectoryServices.AccountManagement.AuthenticablePrincipal
{
public static new T FindByIdentity<T>(PrincipalContext context, string identityValue) where T : UserPrincipal
public static new T FindByIdentity<T>(PrincipalContext context, IdentityType identityType, string identityValue) where T : UserPrincipal
}
API Usage
PrincipalContext ctx = new PrincipalContext(ContextType.Machine);
Principal.FindByIdentity<UserPrincipal>(ctx, IdentityType.SamAccountName, "Guest");
Alternative Designs
No response
Risks
No response
- Dominant language
- C#
- Stars
- 18.3k
- Forks
- 5.6k
- PR merge metrics
- PR metrics pending
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/runtime
-
agentic-workflows untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
area-System.Reflection blocking-clean-ci-optional Known Build Error os-mac-os-x untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
area-CodeGen-coreclr untriaged
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
agentic-workflows untriaged
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
area-VM-meta-mono untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·
-
area/docs-content Bug pulumi/docs
Difficulty 1/5 1-3 hours Newbie friendliness 94/100
-
Create parent directories only after the containment check in InstallHelper.TryExtractToDirectory Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSResourceGet#2056 ·