Class AuthChallengeRequest
java.lang.Object
com.inductiveautomation.perspective.gateway.api.AuthChallengeRequest
Immutable representation of an authentication challenge request
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classProvides a fluent-API (builder-style) pattern for creating newAuthChallengeRequestobjectsstatic classAJsonSerializerandJsonDeserializerimplementation for serializing and de-serializingAuthChallengeRequestobjects to / from JSON using GSON APIs. -
Method Summary
Modifier and TypeMethodDescriptionstatic AuthChallengeRequest.Builderbuilder(AuthChallengeRequest authChallengeRequest) static AuthChallengeRequest.BuildergetIdp()Optional<com.inductiveautomation.ignition.common.gson.JsonElement> toString()
-
Method Details
-
getClient
- Returns:
- the client identifier associated with this auth challenge request
-
getIdp
-
getForceAuth
-
getTimeout
-
getPayload
-
getFramingOption
- Returns:
- an
Optionalcontaining theFramingOptionfor this authentication challenge request, or an empty Optional if this property was not specified.
-
toString
-
builder
- Returns:
- a new
AuthChallengeRequest.Builderinstance
-
builder
- Parameters:
authChallengeRequest- theAuthChallengeRequestwhose properties will be used to initialize the newAuthChallengeRequest.Builderinstance returned from this method- Returns:
- a new
AuthChallengeRequest.Builderinstance with the properties set from the providedAuthChallengeRequest
-