User (Graylog 4.1.1 API)

All Superinterfaces:

Persisted

All Known Implementing Classes:

UserImpl, UserImpl.LocalAdminUser
```
public interface User
extends Persisted
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class User.AccountStatus

Nested Classes
Modifier and Type	Interface and Description
`static class`	`User.AccountStatus`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`User.AccountStatus`	`getAccountStatus()`
`String`	`getAuthServiceId()`
`String`	`getAuthServiceUid()`
`String`	`getEmail()` Returns the email address of the user.
`Optional<String>`	`getFirstName()`
`String`	`getFullName()`
`String`	`getHashedPassword()`
`Optional<String>`	`getLastName()`
`String`	`getName()`
`Set<org.apache.shiro.authz.Permission>`	`getObjectPermissions()`
`List<String>`	`getPermissions()`
`Map<String,Object>`	`getPreferences()`
`Set<String>`	`getRoleIds()`
`long`	`getSessionTimeoutMs()`
`Startpage`	`getStartpage()`
`org.joda.time.DateTimeZone`	`getTimeZone()`
`boolean`	`isExternalUser()`
`boolean`	`isLocalAdmin()`
`boolean`	`isReadOnly()`
`boolean`	`isUserPassword(String password)`
`void`	`setAccountStatus(User.AccountStatus status)`
`void`	`setAuthServiceId(String authServiceId)`
`void`	`setAuthServiceUid(String authServiceUid)`
`void`	`setEmail(String email)`
`void`	`setExternal(boolean external)`
`void`	`setFirstLastFullNames(String firstName, String lastName)` Set the first, last, and full user's name.
`void`	`setFullName(String fullname)` Deprecated.
`void`	`setName(String username)`
`void`	`setPassword(String password)`
`void`	`setPermissions(List<String> permissions)`
`void`	`setPreferences(Map<String,Object> preferences)`
`void`	`setRoleIds(Set<String> roles)`
`void`	`setSessionTimeoutMs(long timeoutValue)`
`void`	`setStartpage(Startpage startpage)`
`void`	`setStartpage(String type, String id)`
`void`	`setTimeZone(org.joda.time.DateTimeZone timeZone)`
`void`	`setTimeZone(String timeZone)`

Methods inherited from interface org.graylog2.plugin.database.Persisted
asMap, getEmbeddedValidations, getFields, getId, getValidations

Method Detail

isReadOnly
```
boolean isReadOnly()
```

getAuthServiceId
```
@Nullable
String getAuthServiceId()
```

getAuthServiceUid
```
@Nullable
String getAuthServiceUid()
```

getFirstName
```
Optional<String> getFirstName()
```

getLastName
```
Optional<String> getLastName()
```

getFullName
```
String getFullName()
```

getName
```
String getName()
```

setName
```
void setName(String username)
```

getEmail
```
String getEmail()
```
Returns the email address of the user. Depending on how the user has been created, it is possible that the returned string contains multiple email addresses separated by a "," character. (i.e. LDAP users)

Returns:

the email address

getPermissions
```
List<String> getPermissions()
```

getObjectPermissions

Set<org.apache.shiro.authz.Permission> getObjectPermissions()

getPreferences
```
Map<String,Object> getPreferences()
```

getStartpage
```
Startpage getStartpage()
```

getSessionTimeoutMs
```
long getSessionTimeoutMs()
```

setSessionTimeoutMs

void setSessionTimeoutMs(long timeoutValue)

setPermissions

void setPermissions(List<String> permissions)

setPreferences

void setPreferences(Map<String,Object> preferences)

setAuthServiceId

void setAuthServiceId(@Nullable
                      String authServiceId)

setAuthServiceUid

void setAuthServiceUid(@Nullable
                       String authServiceUid)

setEmail
```
void setEmail(String email)
```

setFirstLastFullNames
```
void setFirstLastFullNames(String firstName,
                           String lastName)
```
Set the first, last, and full user's name. The full user's full name is composed by concatenating the first and last names together with a space between. For example "First Last".

Parameters:

firstName - Required. The user's first name.

lastName - Required. The user's last name.

setFullName
```
@Deprecated
void setFullName(String fullname)
```
Deprecated.

Set the user's full name. Starting in Graylog 4.1, use of this method is deprecated. Prefer use of the setFirstLastFullNames(String, String) method instead when possible. This way, both individual first and last names will be available when needed.

getHashedPassword
```
String getHashedPassword()
```

setPassword
```
void setPassword(String password)
```

isUserPassword

boolean isUserPassword(String password)

getTimeZone

org.joda.time.DateTimeZone getTimeZone()

setTimeZone

void setTimeZone(org.joda.time.DateTimeZone timeZone)

setTimeZone
```
void setTimeZone(String timeZone)
```

isExternalUser
```
boolean isExternalUser()
```

setExternal
```
void setExternal(boolean external)
```

setStartpage

void setStartpage(String type,
                  String id)

setStartpage

void setStartpage(Startpage startpage)

isLocalAdmin
```
boolean isLocalAdmin()
```

getRoleIds
```
@Nonnull
Set<String> getRoleIds()
```

setRoleIds
```
void setRoleIds(Set<String> roles)
```

setAccountStatus

void setAccountStatus(User.AccountStatus status)

getAccountStatus
```
User.AccountStatus getAccountStatus()
```

Interface User

Nested Class Summary

Method Summary

Methods inherited from interface org.graylog2.plugin.database.Persisted

Method Detail

isReadOnly

getAuthServiceId

getAuthServiceUid

getFirstName

getLastName

getFullName

getName

setName

getEmail

getPermissions

getObjectPermissions

getPreferences

getStartpage

getSessionTimeoutMs

setSessionTimeoutMs

setPermissions

setPreferences

setAuthServiceId

setAuthServiceUid

setEmail

setFirstLastFullNames

setFullName

getHashedPassword

setPassword

isUserPassword

getTimeZone

setTimeZone

setTimeZone

isExternalUser

setExternal

setStartpage

setStartpage

isLocalAdmin

getRoleIds

setRoleIds

setAccountStatus

getAccountStatus