sh.ory.model.SelfServiceSettingsFlow

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-03-08T19:41:46.895754881Z[Etc/UTC]")
public class SelfServiceSettingsFlow
extends Object

This flow is used when an identity wants to update settings (e.g. profile data, passwords, ...) in a selfservice manner. We recommend reading the [User Settings Documentation](../self-service/flows/user-settings)

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_IDENTITY`
`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

SelfServiceSettingsFlow()

Method Summary

Modifier and Type	Method	Description
`SelfServiceSettingsFlow`	`active(String active)`
`boolean`	`equals(Object o)`
`SelfServiceSettingsFlow`	`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 flow expires.
`UUID`	`getId()`	Get id
`Identity`	`getIdentity()`	Get identity
`OffsetDateTime`	`getIssuedAt()`	IssuedAt is the time (UTC) when the flow occurred.
`String`	`getRequestUrl()`	RequestURL is the initial URL that was requested from Ory Kratos.
`String`	`getReturnTo()`	ReturnTo contains the requested return_to URL.
`SelfServiceSettingsFlowState`	`getState()`	Get state
`String`	`getType()`	The flow type can either be `api` or `browser`.
`UiContainer`	`getUi()`	Get ui
`int`	`hashCode()`
`SelfServiceSettingsFlow`	`id(UUID id)`
`SelfServiceSettingsFlow`	`identity(Identity identity)`
`SelfServiceSettingsFlow`	`issuedAt(OffsetDateTime issuedAt)`
`SelfServiceSettingsFlow`	`requestUrl(String requestUrl)`
`SelfServiceSettingsFlow`	`returnTo(String returnTo)`
`void`	`setActive(String active)`
`void`	`setExpiresAt(OffsetDateTime expiresAt)`
`void`	`setId(UUID id)`
`void`	`setIdentity(Identity identity)`
`void`	`setIssuedAt(OffsetDateTime issuedAt)`
`void`	`setRequestUrl(String requestUrl)`
`void`	`setReturnTo(String returnTo)`
`void`	`setState(SelfServiceSettingsFlowState state)`
`void`	`setType(String type)`
`void`	`setUi(UiContainer ui)`
`SelfServiceSettingsFlow`	`state(SelfServiceSettingsFlowState state)`
`String`	`toString()`
`SelfServiceSettingsFlow`	`type(String type)`
`SelfServiceSettingsFlow`	`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_IDENTITY
  
  public static final String SERIALIZED_NAME_IDENTITY
  
  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
- SelfServiceSettingsFlow
  
  public SelfServiceSettingsFlow()
Method Details
- active
  
  public SelfServiceSettingsFlow 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 SelfServiceSettingsFlow expiresAt(OffsetDateTime expiresAt)
- getExpiresAt
  
  @Nonnull public OffsetDateTime getExpiresAt()
  
  ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting, a new flow has to be initiated.
  
  Returns:
  
  expiresAt
- setExpiresAt
  
  public void setExpiresAt(OffsetDateTime expiresAt)
- id
  
  public SelfServiceSettingsFlow id(UUID id)
- getId
  
  @Nonnull public UUID getId()
  
  Get id
  
  Returns:
  
  id
- setId
  
  public void setId(UUID id)
- identity
  
  public SelfServiceSettingsFlow identity(Identity identity)
- getIdentity
  
  @Nonnull public Identity getIdentity()
  
  Get identity
  
  Returns:
  
  identity
- setIdentity
  
  public void setIdentity(Identity identity)
- issuedAt
  
  public SelfServiceSettingsFlow issuedAt(OffsetDateTime issuedAt)
- getIssuedAt
  
  @Nonnull public OffsetDateTime getIssuedAt()
  
  IssuedAt is the time (UTC) when the flow occurred.
  
  Returns:
  
  issuedAt
- setIssuedAt
  
  public void setIssuedAt(OffsetDateTime issuedAt)
- requestUrl
  
  public SelfServiceSettingsFlow 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 SelfServiceSettingsFlow 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 SelfServiceSettingsFlow state(SelfServiceSettingsFlowState state)
- getState
  
  @Nonnull public SelfServiceSettingsFlowState getState()
  
  Get state
  
  Returns:
  
  state
- setState
  
  public void setState(SelfServiceSettingsFlowState state)
- type
  
  public SelfServiceSettingsFlow type(String type)
- getType
  
  @Nullable public String getType()
  
  The flow type can either be `api` or `browser`.
  
  Returns:
  
  type
- setType
  
  public void setType(String type)
- ui
  
  public SelfServiceSettingsFlow 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

Class SelfServiceSettingsFlow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

SERIALIZED_NAME_ACTIVE

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_ID

SERIALIZED_NAME_IDENTITY

SERIALIZED_NAME_ISSUED_AT

SERIALIZED_NAME_REQUEST_URL

SERIALIZED_NAME_RETURN_TO

SERIALIZED_NAME_STATE

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_UI

Constructor Details

SelfServiceSettingsFlow

Method Details

active

getActive

setActive

expiresAt

getExpiresAt

setExpiresAt

id

getId

setId

identity

getIdentity

setIdentity

issuedAt

getIssuedAt

setIssuedAt

requestUrl

getRequestUrl

setRequestUrl

returnTo

getReturnTo

setReturnTo

state

getState

setState

type

getType

setType

ui

getUi

setUi

equals

hashCode

toString