org.sonar.api.server.authentication

Class UserIdentity

java.lang.Object

org.sonar.api.server.authentication.UserIdentity

@Immutable
public final class UserIdentity
extends Object

User information provided by the Identity Provider to be register into the platform.

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserIdentity.Builder

Method Summary

Modifier and Type	Method and Description
static UserIdentity.Builder	builder()
String	getEmail() Optional non-blank email.
Set<String>	getGroups() List of group membership of the user.
String	getLogin() Non-blank user login, unique for the SonarQube platform.
String	getName() Non-blank display name.
String	getProviderLogin() Non-blank user login for the related IdentityProvider.
boolean	shouldSyncGroups() Return true if groups should be synchronized for this user.

Methods inherited from class java.lang.Object

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

Method Detail

getProviderLogin

public String getProviderLogin()

Non-blank user login for the related IdentityProvider.

getLogin

public String getLogin()

Non-blank user login, unique for the SonarQube platform. If two IdentityProvider define two users with the same login, then users are considered as identical.

getName

public String getName()

Non-blank display name. Uniqueness is not mandatory, even it's recommended for easier search of users in webapp.

getEmail

@CheckForNull
public String getEmail()

Optional non-blank email. If defined, then it must be unique among all the users defined by all IdentityProvider. If not unique, then authentication will fail.

shouldSyncGroups

public boolean shouldSyncGroups()

Return true if groups should be synchronized for this user.

Since:

5.5

getGroups

public Set<String> getGroups()

List of group membership of the user. Only existing groups in SonarQube will be synchronized.

Since:

5.5

builder

public static UserIdentity.Builder builder()