AuthRequest (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.account.AuthRequest

```
public class AuthRequest
extends Object
```
Information for AccountManager.authenticate(AuthRequest).
Callers should populate this object with as much information as possible about the user account. For example, OpenID authentication might return registration information including a display name for the user, and an email address for them. These fields however are optional, as not all OpenID providers return them, and not all non-OpenID systems can use them.

Constructor Summary

Constructors
Constructor and Description

AuthRequest(String externalId)

Constructors
Constructor and Description
`AuthRequest(String externalId)`

Method Summary

Methods
Modifier and Type	Method and Description
`static AuthRequest`	`forEmail(String email)` Create a request for an email address registration.
`static AuthRequest`	`forExternalUser(String username)` Create a request for an external username.
`static AuthRequest`	`forUser(String username)` Create a request for a local username, such as from LDAP.
`String`	`getAuthPlugin()`
`String`	`getAuthProvider()`
`String`	`getDisplayName()`
`String`	`getEmailAddress()`
`String`	`getExternalId()`
`String`	`getLocalUser()`
`String`	`getPassword()`
`String`	`getUserName()`
`boolean`	`isScheme(String scheme)`
`boolean`	`isSkipAuthentication()`
`void`	`setAuthPlugin(String authPlugin)`
`void`	`setAuthProvider(String authProvider)`
`void`	`setDisplayName(String name)`
`void`	`setEmailAddress(String email)`
`void`	`setLocalUser(String localUser)`
`void`	`setPassword(String pass)`
`void`	`setSkipAuthentication(boolean skip)`
`void`	`setUserName(String user)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AuthRequest
```
public AuthRequest(String externalId)
```

Method Detail

forUser
```
public static AuthRequest forUser(String username)
```
Create a request for a local username, such as from LDAP.

forExternalUser

public static AuthRequest forExternalUser(String username)

Create a request for an external username.

forEmail
```
public static AuthRequest forEmail(String email)
```
Create a request for an email address registration.
This type of request should be used only to attach a new email address to an existing user account.

getExternalId
```
public String getExternalId()
```

isScheme

public boolean isScheme(String scheme)

getLocalUser
```
public String getLocalUser()
```

setLocalUser

public void setLocalUser(String localUser)

getPassword
```
public String getPassword()
```

setPassword
```
public void setPassword(String pass)
```

getDisplayName
```
public String getDisplayName()
```

setDisplayName

public void setDisplayName(String name)

getEmailAddress
```
public String getEmailAddress()
```

setEmailAddress

public void setEmailAddress(String email)

getUserName
```
public String getUserName()
```

setUserName
```
public void setUserName(String user)
```

isSkipAuthentication
```
public boolean isSkipAuthentication()
```

setSkipAuthentication

public void setSkipAuthentication(boolean skip)

getAuthPlugin
```
public String getAuthPlugin()
```

setAuthPlugin

public void setAuthPlugin(String authPlugin)

getAuthProvider
```
public String getAuthProvider()
```

setAuthProvider

public void setAuthProvider(String authProvider)

Class AuthRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthRequest

Method Detail

forUser

forExternalUser

forEmail

getExternalId

isScheme

getLocalUser

setLocalUser

getPassword

setPassword

getDisplayName

setDisplayName

getEmailAddress

setEmailAddress

getUserName

setUserName

isSkipAuthentication

setSkipAuthentication

getAuthPlugin

setAuthPlugin

getAuthProvider

setAuthProvider