org.sonar.api.server.authentication

Interface IdentityProvider

All Known Subinterfaces:

BaseIdentityProvider, OAuth2IdentityProvider

@ServerSide
public interface IdentityProvider

Entry-point to define a new Identity provider. Only one of this two interfaces can be used :

• OAuth2IdentityProvider for OAuth2 authentication
• BaseIdentityProvider for other kind of authentication

Since:

5.4

Method Summary

Modifier and Type	Method and Description
boolean	allowsUsersToSignUp() Can users sign-up (connecting with their account for the first time) ? If true, then users can register and create their account into SonarQube, else only already registered users can login.
Display	getDisplay() Display information for the login form
String	getKey() Unique key of provider, for example "github".
String	getName() Name displayed in login form.
boolean	isEnabled() Is the provider fully configured and enabled ? If true, then the provider is available in login form.

Method Detail

getKey

String getKey()

Unique key of provider, for example "github". Must not be blank.

getName

String getName()

Name displayed in login form. Must not be blank.

getDisplay

Display getDisplay()

Display information for the login form

isEnabled

boolean isEnabled()

Is the provider fully configured and enabled ? If true, then the provider is available in login form.

allowsUsersToSignUp

boolean allowsUsersToSignUp()

Can users sign-up (connecting with their account for the first time) ? If true, then users can register and create their account into SonarQube, else only already registered users can login.