java.lang.Object
- sh.ory.hydra.model.LoginRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-12T16:13:57.119092Z[GMT]")
public class LoginRequest
extends Object

LoginRequest

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_CHALLENGE`
`static String`	`SERIALIZED_NAME_CLIENT`
`static String`	`SERIALIZED_NAME_OIDC_CONTEXT`
`static String`	`SERIALIZED_NAME_REQUEST_URL`
`static String`	`SERIALIZED_NAME_REQUESTED_ACCESS_TOKEN_AUDIENCE`
`static String`	`SERIALIZED_NAME_REQUESTED_SCOPE`
`static String`	`SERIALIZED_NAME_SESSION_ID`
`static String`	`SERIALIZED_NAME_SKIP`
`static String`	`SERIALIZED_NAME_SUBJECT`

Constructor Summary

Constructors
Constructor Description

LoginRequest()

Method Summary

Modifier and Type	Method	Description
`LoginRequest`	`addRequestedAccessTokenAudienceItem(String requestedAccessTokenAudienceItem)`
`LoginRequest`	`addRequestedScopeItem(String requestedScopeItem)`
`LoginRequest`	`challenge(String challenge)`
`LoginRequest`	`client(OAuth2Client client)`
`boolean`	`equals(Object o)`
`String`	`getChallenge()`	ID is the identifier (\"login challenge\") of the login request.
`OAuth2Client`	`getClient()`	Get client
`OpenIDConnectContext`	`getOidcContext()`	Get oidcContext
`List<String>`	`getRequestedAccessTokenAudience()`	Get requestedAccessTokenAudience
`List<String>`	`getRequestedScope()`	Get requestedScope
`String`	`getRequestUrl()`	RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client.
`String`	`getSessionId()`	SessionID is the login session ID.
`Boolean`	`getSkip()`	Skip, if true, implies that the client has requested the same scopes from the same user previously.
`String`	`getSubject()`	Subject is the user ID of the end-user that authenticated.
`int`	`hashCode()`
`LoginRequest`	`oidcContext(OpenIDConnectContext oidcContext)`
`LoginRequest`	`requestedAccessTokenAudience(List<String> requestedAccessTokenAudience)`
`LoginRequest`	`requestedScope(List<String> requestedScope)`
`LoginRequest`	`requestUrl(String requestUrl)`
`LoginRequest`	`sessionId(String sessionId)`
`void`	`setChallenge(String challenge)`
`void`	`setClient(OAuth2Client client)`
`void`	`setOidcContext(OpenIDConnectContext oidcContext)`
`void`	`setRequestedAccessTokenAudience(List<String> requestedAccessTokenAudience)`
`void`	`setRequestedScope(List<String> requestedScope)`
`void`	`setRequestUrl(String requestUrl)`
`void`	`setSessionId(String sessionId)`
`void`	`setSkip(Boolean skip)`
`void`	`setSubject(String subject)`
`LoginRequest`	`skip(Boolean skip)`
`LoginRequest`	`subject(String subject)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_CHALLENGE
```
public static final String SERIALIZED_NAME_CHALLENGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT
```
public static final String SERIALIZED_NAME_CLIENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OIDC_CONTEXT
```
public static final String SERIALIZED_NAME_OIDC_CONTEXT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUEST_URL
```
public static final String SERIALIZED_NAME_REQUEST_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUESTED_ACCESS_TOKEN_AUDIENCE
```
public static final String SERIALIZED_NAME_REQUESTED_ACCESS_TOKEN_AUDIENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUESTED_SCOPE
```
public static final String SERIALIZED_NAME_REQUESTED_SCOPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SESSION_ID
```
public static final String SERIALIZED_NAME_SESSION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SKIP
```
public static final String SERIALIZED_NAME_SKIP
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUBJECT
```
public static final String SERIALIZED_NAME_SUBJECT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoginRequest
```
public LoginRequest()
```
- Method Detail
  - challenge
```
public LoginRequest challenge(String challenge)
```
  - getChallenge
```
public String getChallenge()
```
    ID is the identifier (\"login challenge\") of the login request. It is used to identify the session.
    
    Returns:
    
    challenge
  - setChallenge
```
public void setChallenge(String challenge)
```
  - client
```
public LoginRequest client(OAuth2Client client)
```
  - getClient
```
public OAuth2Client getClient()
```
    Get client
    
    Returns:
    
    client
  - setClient
```
public void setClient(OAuth2Client client)
```
  - oidcContext
```
public LoginRequest oidcContext(OpenIDConnectContext oidcContext)
```
  - getOidcContext
```
@Nullable
public OpenIDConnectContext getOidcContext()
```
    Get oidcContext
    
    Returns:
    
    oidcContext
  - setOidcContext
```
public void setOidcContext(OpenIDConnectContext oidcContext)
```
  - requestUrl
```
public LoginRequest requestUrl(String requestUrl)
```
  - getRequestUrl
```
public String getRequestUrl()
```
    RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
    
    Returns:
    
    requestUrl
  - setRequestUrl
```
public void setRequestUrl(String requestUrl)
```
  - requestedAccessTokenAudience
```
public LoginRequest requestedAccessTokenAudience(List<String> requestedAccessTokenAudience)
```
  - addRequestedAccessTokenAudienceItem
```
public LoginRequest addRequestedAccessTokenAudienceItem(String requestedAccessTokenAudienceItem)
```
  - getRequestedAccessTokenAudience
```
public List<String> getRequestedAccessTokenAudience()
```
    Get requestedAccessTokenAudience
    
    Returns:
    
    requestedAccessTokenAudience
  - setRequestedAccessTokenAudience
```
public void setRequestedAccessTokenAudience(List<String> requestedAccessTokenAudience)
```
  - requestedScope
```
public LoginRequest requestedScope(List<String> requestedScope)
```
  - addRequestedScopeItem
```
public LoginRequest addRequestedScopeItem(String requestedScopeItem)
```
  - getRequestedScope
```
public List<String> getRequestedScope()
```
    Get requestedScope
    
    Returns:
    
    requestedScope
  - setRequestedScope
```
public void setRequestedScope(List<String> requestedScope)
```
  - sessionId
```
public LoginRequest sessionId(String sessionId)
```
  - getSessionId
```
@Nullable
public String getSessionId()
```
    SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
    
    Returns:
    
    sessionId
  - setSessionId
```
public void setSessionId(String sessionId)
```
  - skip
```
public LoginRequest skip(Boolean skip)
```
  - getSkip
```
public Boolean getSkip()
```
    Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.
    
    Returns:
    
    skip
  - setSkip
```
public void setSkip(Boolean skip)
```
  - subject
```
public LoginRequest subject(String subject)
```
  - getSubject
```
public String getSubject()
```
    Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail.
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - 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

Class LoginRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CHALLENGE

SERIALIZED_NAME_CLIENT

SERIALIZED_NAME_OIDC_CONTEXT

SERIALIZED_NAME_REQUEST_URL

SERIALIZED_NAME_REQUESTED_ACCESS_TOKEN_AUDIENCE

SERIALIZED_NAME_REQUESTED_SCOPE

SERIALIZED_NAME_SESSION_ID

SERIALIZED_NAME_SKIP

SERIALIZED_NAME_SUBJECT

Constructor Detail

LoginRequest

Method Detail

challenge

getChallenge

setChallenge

client

getClient

setClient

oidcContext

getOidcContext

setOidcContext

requestUrl

getRequestUrl

setRequestUrl

requestedAccessTokenAudience

addRequestedAccessTokenAudienceItem

getRequestedAccessTokenAudience

setRequestedAccessTokenAudience

requestedScope

addRequestedScopeItem

getRequestedScope

setRequestedScope

sessionId

getSessionId

setSessionId

skip

getSkip

setSkip

subject

getSubject

setSubject

equals

hashCode

toString