Package se.curity.identityserver.sdk.authentication

Class BackchannelAuthenticationRequest

Object

se.curity.identityserver.sdk.authentication.BackchannelAuthenticationRequest

public final class BackchannelAuthenticationRequest
extends Object

Describes the data structure that provides all information needed to fulfill a backchannel authentication request

Constructor Summary

Constructors

Constructor	Description
BackchannelAuthenticationRequest(String subject, @Nullable String usercode, @Nullable String bindingMessage, ClientIdentifier clientIdentifier, Set<ScopeValue> scopes, ClaimSet claims, Request originalRequest)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getBindingMessage()	The binding message that was given by the client, used to inform the user about the backchannel authentication request.
@Nullable ClaimSet	getClaims()	The requested claims that are allowed for the client.
@Nullable ClientIdentifier	getClientIdentifier()	The ClientIdentifier of the requesting OAuth client.
Request	getOriginalRequest()	The original HTTP request for this backchannel authentication request.
@Nullable Set<ScopeValue>	getScopes()	The requested scopes that are allowed for the client.
String	getSubject()	The subject that is requested to authenticate.
@Nullable String	getUserCode()	The usercode that was given by the client to be used to complete a backchannel authentication request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BackchannelAuthenticationRequest

public BackchannelAuthenticationRequest(String subject,
 @Nullable String usercode,
 @Nullable String bindingMessage,
 ClientIdentifier clientIdentifier,
 Set<ScopeValue> scopes,
 ClaimSet claims,
 Request originalRequest)

Method Details

getSubject

public String getSubject()

The subject that is requested to authenticate.

Returns:

the subject

getUserCode

@Nullable
public @Nullable String getUserCode()

The usercode that was given by the client to be used to complete a backchannel authentication request.

Returns:

the usercode, or null if no usercode was provided by the client

getBindingMessage

@Nullable
public @Nullable String getBindingMessage()

The binding message that was given by the client, used to inform the user about the backchannel authentication request.

Returns:

the binding message, or null if no binding message was provided by the client

getClientIdentifier

@Nullable
public @Nullable ClientIdentifier getClientIdentifier()

The ClientIdentifier of the requesting OAuth client.

Returns:

the ClientIdentifier, or null if this request wasn't made by an OAuth client

Since:

6.3.0

getScopes

@Nullable
public @Nullable Set<ScopeValue> getScopes()

The requested scopes that are allowed for the client.

Returns:

the scopes, or null if this request wasn't made by an OAuth client

Since:

6.3.0

getClaims

@Nullable
public @Nullable ClaimSet getClaims()

The requested claims that are allowed for the client. Some claims may be implicitly inferred from the requested scope.

Returns:

the claims, or null if this request wasn't made by an OAuth client.

Since:

6.3.0

getOriginalRequest

public Request getOriginalRequest()

The original HTTP request for this backchannel authentication request.

Returns:

the original HTTP request

Since:

6.3.0