Package com.inductiveautomation.ignition.common.auth.web

Class WebAuthUserContext

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

public class WebAuthUserContext
extends java.lang.Object
implements java.io.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(java.lang.Object o)
java.util.Optional<java.lang.String>	getIdp()
com.google.common.collect.ImmutableCollection<SecurityLevelConfig>	getSecurityLevels()
com.google.common.collect.ImmutableCollection<java.lang.String>	getSecurityZones()
java.util.Optional<WebAuthUser>	getWebAuthUser()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getIdp

public java.util.Optional<java.lang.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<java.lang.String> getSecurityZones()

Returns:

the names of the security zones that the user belongs to in this context

getWebAuthUser

public java.util.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static WebAuthUserContext.Builder builder()

Returns:

a new WebAuthUserContext.Builder instance