Package sh.ory.model

Class SelfServiceLoginFlow

java.lang.Object

sh.ory.model.SelfServiceLoginFlow

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-04-19T11:31:27.587817519Z[Etc/UTC]")
public class SelfServiceLoginFlow
extends Object

This object represents a login flow. A login flow is initiated at the \"Initiate Login API / Browser Flow\" endpoint by a client. Once a login flow is completed successfully, a session cookie or session token will be issued.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_ACTIVE
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_EXPIRES_AT
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_ISSUED_AT
static String	SERIALIZED_NAME_REFRESH
static String	SERIALIZED_NAME_REQUEST_URL
static String	SERIALIZED_NAME_REQUESTED_AAL
static String	SERIALIZED_NAME_RETURN_TO
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_UI
static String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
SelfServiceLoginFlow()

Method Summary

Modifier and Type	Method	Description
SelfServiceLoginFlow	active(IdentityCredentialsType active)
SelfServiceLoginFlow	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
SelfServiceLoginFlow	expiresAt(OffsetDateTime expiresAt)
IdentityCredentialsType	getActive()	Get active
OffsetDateTime	getCreatedAt()	CreatedAt is a helper struct field for gobuffalo.pop.
OffsetDateTime	getExpiresAt()	ExpiresAt is the time (UTC) when the flow expires.
UUID	getId()	Get id
OffsetDateTime	getIssuedAt()	IssuedAt is the time (UTC) when the flow started.
Boolean	getRefresh()	Refresh stores whether this login flow should enforce re-authentication.
AuthenticatorAssuranceLevel	getRequestedAal()	Get requestedAal
String	getRequestUrl()	RequestURL is the initial URL that was requested from Ory Kratos.
String	getReturnTo()	ReturnTo contains the requested return_to URL.
String	getType()	The flow type can either be `api` or `browser`.
UiContainer	getUi()	Get ui
OffsetDateTime	getUpdatedAt()	UpdatedAt is a helper struct field for gobuffalo.pop.
int	hashCode()
SelfServiceLoginFlow	id(UUID id)
SelfServiceLoginFlow	issuedAt(OffsetDateTime issuedAt)
SelfServiceLoginFlow	refresh(Boolean refresh)
SelfServiceLoginFlow	requestedAal(AuthenticatorAssuranceLevel requestedAal)
SelfServiceLoginFlow	requestUrl(String requestUrl)
SelfServiceLoginFlow	returnTo(String returnTo)
void	setActive(IdentityCredentialsType active)
void	setCreatedAt(OffsetDateTime createdAt)
void	setExpiresAt(OffsetDateTime expiresAt)
void	setId(UUID id)
void	setIssuedAt(OffsetDateTime issuedAt)
void	setRefresh(Boolean refresh)
void	setRequestedAal(AuthenticatorAssuranceLevel requestedAal)
void	setRequestUrl(String requestUrl)
void	setReturnTo(String returnTo)
void	setType(String type)
void	setUi(UiContainer ui)
void	setUpdatedAt(OffsetDateTime updatedAt)
String	toString()
SelfServiceLoginFlow	type(String type)
SelfServiceLoginFlow	ui(UiContainer ui)
SelfServiceLoginFlow	updatedAt(OffsetDateTime updatedAt)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRES_AT

public static final String SERIALIZED_NAME_EXPIRES_AT

See Also:

Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUED_AT

public static final String SERIALIZED_NAME_ISSUED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_REFRESH

public static final String SERIALIZED_NAME_REFRESH

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_AAL

public static final String SERIALIZED_NAME_REQUESTED_AAL

See Also:

Constant Field Values

SERIALIZED_NAME_RETURN_TO

public static final String SERIALIZED_NAME_RETURN_TO

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_UI

public static final String SERIALIZED_NAME_UI

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

Constructor Details

SelfServiceLoginFlow

public SelfServiceLoginFlow()

Method Details

active

public SelfServiceLoginFlow active(IdentityCredentialsType active)

getActive

@Nullable
public IdentityCredentialsType getActive()

Get active

Returns:

active

setActive

public void setActive(IdentityCredentialsType active)

createdAt

public SelfServiceLoginFlow createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

CreatedAt is a helper struct field for gobuffalo.pop.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

expiresAt

public SelfServiceLoginFlow expiresAt(OffsetDateTime expiresAt)

getExpiresAt

@Nonnull
public OffsetDateTime getExpiresAt()

ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(OffsetDateTime expiresAt)

id

public SelfServiceLoginFlow id(UUID id)

getId

@Nonnull
public UUID getId()

Get id

Returns:

id

setId

public void setId(UUID id)

issuedAt

public SelfServiceLoginFlow issuedAt(OffsetDateTime issuedAt)

getIssuedAt

@Nonnull
public OffsetDateTime getIssuedAt()

IssuedAt is the time (UTC) when the flow started.

Returns:

issuedAt

setIssuedAt

public void setIssuedAt(OffsetDateTime issuedAt)

refresh

public SelfServiceLoginFlow refresh(Boolean refresh)

getRefresh

@Nullable
public Boolean getRefresh()

Refresh stores whether this login flow should enforce re-authentication.

Returns:

refresh

setRefresh

public void setRefresh(Boolean refresh)

requestUrl

public SelfServiceLoginFlow requestUrl(String requestUrl)

getRequestUrl

@Nonnull
public String getRequestUrl()

RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example.

Returns:

requestUrl

setRequestUrl

public void setRequestUrl(String requestUrl)

requestedAal

public SelfServiceLoginFlow requestedAal(AuthenticatorAssuranceLevel requestedAal)

getRequestedAal

@Nullable
public AuthenticatorAssuranceLevel getRequestedAal()

Get requestedAal

Returns:

requestedAal

setRequestedAal

public void setRequestedAal(AuthenticatorAssuranceLevel requestedAal)

returnTo

public SelfServiceLoginFlow returnTo(String returnTo)

getReturnTo

@Nullable
public String getReturnTo()

ReturnTo contains the requested return_to URL.

Returns:

returnTo

setReturnTo

public void setReturnTo(String returnTo)

type

public SelfServiceLoginFlow type(String type)

getType

@Nonnull
public String getType()

The flow type can either be `api` or `browser`.

Returns:

type

setType

public void setType(String type)

ui

public SelfServiceLoginFlow ui(UiContainer ui)

getUi

@Nonnull
public UiContainer getUi()

Get ui

Returns:

ui

setUi

public void setUi(UiContainer ui)

updatedAt

public SelfServiceLoginFlow updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

UpdatedAt is a helper struct field for gobuffalo.pop.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

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