Package com.microsoft.jenkins.azuread

Class EntraIdPrincipalSearchProvider

java.lang.Object

io.jenkins.plugins.authcommons.PrincipalSearchProvider

com.microsoft.jenkins.azuread.EntraIdPrincipalSearchProvider

All Implemented Interfaces:

ExtensionPoint

@Extension
public class EntraIdPrincipalSearchProvider
extends io.jenkins.plugins.authcommons.PrincipalSearchProvider

Lets authorization strategies such as Matrix Authorization Strategy and Role-based Authorization Strategy autocomplete Entra ID users and groups.

Both users and groups are identified by their object id, which is what AzureAdUser uses as its username and group authorities.

Users get an avatar URL pointing to EntraIdPhotoProxy on the object the search was made from, so that viewing photos requires the same permission as configuring access there.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
EntraIdPrincipalSearchProvider()

Method Summary

Modifier and Type	Method	Description
boolean	isApplicable(SecurityRealm realm)
io.jenkins.plugins.authcommons.Principal	lookup(String sid, io.jenkins.plugins.authcommons.PrincipalType type)
List<io.jenkins.plugins.authcommons.Principal>	search(String query, Set<io.jenkins.plugins.authcommons.PrincipalType> types, int limit)

Methods inherited from class io.jenkins.plugins.authcommons.PrincipalSearchProvider

all

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EntraIdPrincipalSearchProvider

public EntraIdPrincipalSearchProvider()

Method Details

isApplicable

public boolean isApplicable(@NonNull
 SecurityRealm realm)

Specified by:

isApplicable in class io.jenkins.plugins.authcommons.PrincipalSearchProvider

search

@NonNull
public List<io.jenkins.plugins.authcommons.Principal> search(@NonNull
 String query,
 @NonNull
 Set<io.jenkins.plugins.authcommons.PrincipalType> types,
 int limit)

Specified by:

search in class io.jenkins.plugins.authcommons.PrincipalSearchProvider

lookup

@CheckForNull
public io.jenkins.plugins.authcommons.Principal lookup(@NonNull
 String sid,
 @NonNull
 io.jenkins.plugins.authcommons.PrincipalType type)

Overrides:

lookup in class io.jenkins.plugins.authcommons.PrincipalSearchProvider