WebAuthUserContext

java.lang.Object

com.inductiveautomation.ignition.common.auth.web.WebAuthUserContext

All Implemented Interfaces:: Serializable

public class WebAuthUserContext extends Object implements Serializable

Provides context about a user who authenticated using web-based protocols such as OIDC or SAML

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

WebAuthUserContext.Builder

Provides a fluent-API (builder-style) pattern for creating new WebAuthUserContext objects

static class

WebAuthUserContext.GsonAdapter

A JsonSerializer and JsonDeserializer implementation for serializing and de-serializing WebAuthUserContext objects to / from JSON using GSON APIs.
Method Summary

Modifier and Type

Method

Description

static WebAuthUserContext.Builder

builder()

boolean

equals(Object o)

Optional<String>

getIdp()

com.google.common.collect.ImmutableCollection<SecurityLevelConfig>

getSecurityLevels()

com.google.common.collect.ImmutableCollection<String>

getSecurityZones()

Optional<WebAuthUser>

getWebAuthUser()

int

hashCode()

String

toString()

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

Method Details
- getIdp
  
  public Optional<String> getIdp()
  
  Returns:
  
  an Optional containing the name of the IdP from where the user authenticated, or an empty Optional if the user is not authenticated in this context
- getSecurityZones
  
  public com.google.common.collect.ImmutableCollection<String> getSecurityZones()
  
  Returns:
  
  the names of the security zones that the user belongs to in this context
- getWebAuthUser
  
  public Optional<WebAuthUser> getWebAuthUser()
  
  Returns:
  
  an Optional containing the WebAuthUser which contains attributes such as their username and roles. Returns an empty Optional if the user is not authenticated in this context
- getSecurityLevels
  
  public com.google.common.collect.ImmutableCollection<SecurityLevelConfig> getSecurityLevels()
  
  Returns:
  
  the security levels granted to the user in this context, represented in tree-form as an ImmutableCollection of SecurityLevelConfig objects
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- builder
  
  public static WebAuthUserContext.Builder builder()
  
  Returns:
  
  a new WebAuthUserContext.Builder instance