@Immutable
public final class UserIdentity
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
UserIdentity.Builder |
Modifier and Type | Method and Description |
---|---|
static UserIdentity.Builder |
builder() |
java.lang.String |
getEmail()
Optional non-blank email.
|
java.util.Set<java.lang.String> |
getGroups()
List of group membership of the user.
|
java.lang.String |
getLogin()
User login, unique for the SonarQube platform.
|
java.lang.String |
getName()
Non-blank display name.
|
java.lang.String |
getProviderId()
Optional unique ID for the related
IdentityProvider . |
java.lang.String |
getProviderLogin()
Non-blank user login for the related
IdentityProvider . |
boolean |
shouldSyncGroups()
Return true if groups should be synchronized for this user.
|
@CheckForNull public java.lang.String getProviderId()
IdentityProvider
.
If two IdentityProvider
define two users with the same ID, then users are considered as identical.
When the ID is not provided, the provider login getProviderLogin()
is used.public java.lang.String getProviderLogin()
IdentityProvider
.@CheckForNull public java.lang.String getLogin()
IdentityProvider
define two users with the same login, then users are considered as identical.
Since 7.4, a unique login will be generated if result is null and the user referenced by getProviderId()
or getProviderLogin()
does not already exist.public java.lang.String getName()
@CheckForNull public java.lang.String getEmail()
IdentityProvider
. If not unique, then authentication will fail.public boolean shouldSyncGroups()
public java.util.Set<java.lang.String> getGroups()
public static UserIdentity.Builder builder()