Package sh.ory.model

Class SelfServiceRecoveryFlow

java.lang.Object

sh.ory.model.SelfServiceRecoveryFlow

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-07-26T09:37:11.487071522Z[Etc/UTC]")
public class SelfServiceRecoveryFlow
extends Object

This request is used when an identity wants to recover their account. We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_ACTIVE
static String	SERIALIZED_NAME_EXPIRES_AT
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_ISSUED_AT
static String	SERIALIZED_NAME_REQUEST_URL
static String	SERIALIZED_NAME_RETURN_TO
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_UI

Constructor Summary

Constructors

Constructor	Description
SelfServiceRecoveryFlow()

Method Summary

Modifier and Type	Method	Description
SelfServiceRecoveryFlow	active(String active)
boolean	equals(Object o)
SelfServiceRecoveryFlow	expiresAt(OffsetDateTime expiresAt)
String	getActive()	Active, if set, contains the registration method that is being used.
OffsetDateTime	getExpiresAt()	ExpiresAt is the time (UTC) when the request expires.
UUID	getId()	Get id
OffsetDateTime	getIssuedAt()	IssuedAt is the time (UTC) when the request occurred.
String	getRequestUrl()	RequestURL is the initial URL that was requested from Ory Kratos.
String	getReturnTo()	ReturnTo contains the requested return_to URL.
SelfServiceRecoveryFlowState	getState()	Get state
String	getType()	The flow type can either be `api` or `browser`.
UiContainer	getUi()	Get ui
int	hashCode()
SelfServiceRecoveryFlow	id(UUID id)
SelfServiceRecoveryFlow	issuedAt(OffsetDateTime issuedAt)
SelfServiceRecoveryFlow	requestUrl(String requestUrl)
SelfServiceRecoveryFlow	returnTo(String returnTo)
void	setActive(String active)
void	setExpiresAt(OffsetDateTime expiresAt)
void	setId(UUID id)
void	setIssuedAt(OffsetDateTime issuedAt)
void	setRequestUrl(String requestUrl)
void	setReturnTo(String returnTo)
void	setState(SelfServiceRecoveryFlowState state)
void	setType(String type)
void	setUi(UiContainer ui)
SelfServiceRecoveryFlow	state(SelfServiceRecoveryFlowState state)
String	toString()
SelfServiceRecoveryFlow	type(String type)
SelfServiceRecoveryFlow	ui(UiContainer ui)

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_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_REQUEST_URL

public static final String SERIALIZED_NAME_REQUEST_URL

See Also:

Constant Field Values

SERIALIZED_NAME_RETURN_TO

public static final String SERIALIZED_NAME_RETURN_TO

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

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

Constructor Details

SelfServiceRecoveryFlow

public SelfServiceRecoveryFlow()

Method Details

active

public SelfServiceRecoveryFlow active(String active)

getActive

@Nullable
public String getActive()

Active, if set, contains the registration method that is being used. It is initially not set.

Returns:

active

setActive

public void setActive(String active)

expiresAt

public SelfServiceRecoveryFlow expiresAt(OffsetDateTime expiresAt)

getExpiresAt

@Nonnull
public OffsetDateTime getExpiresAt()

ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated.

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(OffsetDateTime expiresAt)

id

public SelfServiceRecoveryFlow id(UUID id)

getId

@Nonnull
public UUID getId()

Get id

Returns:

id

setId

public void setId(UUID id)

issuedAt

public SelfServiceRecoveryFlow issuedAt(OffsetDateTime issuedAt)

getIssuedAt

@Nonnull
public OffsetDateTime getIssuedAt()

IssuedAt is the time (UTC) when the request occurred.

Returns:

issuedAt

setIssuedAt

public void setIssuedAt(OffsetDateTime issuedAt)

requestUrl

public SelfServiceRecoveryFlow 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)

returnTo

public SelfServiceRecoveryFlow returnTo(String returnTo)

getReturnTo

@Nullable
public String getReturnTo()

ReturnTo contains the requested return_to URL.

Returns:

returnTo

setReturnTo

public void setReturnTo(String returnTo)

state

public SelfServiceRecoveryFlow state(SelfServiceRecoveryFlowState state)

getState

@Nonnull
public SelfServiceRecoveryFlowState getState()

Get state

Returns:

state

setState

public void setState(SelfServiceRecoveryFlowState state)

type

public SelfServiceRecoveryFlow 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 SelfServiceRecoveryFlow ui(UiContainer ui)

getUi

@Nonnull
public UiContainer getUi()

Get ui

Returns:

ui

setUi

public void setUi(UiContainer ui)

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