Package com.okta.sdk.resource.model

Class UserLinks

java.lang.Object

com.okta.sdk.resource.model.UserLinks

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class UserLinks
extends Object
implements Serializable

Specifies link relations (see [Web Linking](https://datatracker.ietf.org/doc/html/rfc8288) available for the current status of a user. The Links object is used for dynamic discovery of related resources, lifecycle operations, and credential operations. The Links object is read-only. For an individual User result, the Links object contains a full set of link relations available for that User as determined by your policies. For a collection of users, the Links object contains only the `self` link. Operations that return a collection of Users include List Users and List Group Members.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACTIVATE
static final String	JSON_PROPERTY_CHANGE_PASSWORD
static final String	JSON_PROPERTY_CHANGE_RECOVERY_QUESTION
static final String	JSON_PROPERTY_DEACTIVATE
static final String	JSON_PROPERTY_EXPIRE_PASSWORD
static final String	JSON_PROPERTY_FORGOT_PASSWORD
static final String	JSON_PROPERTY_REACTIVATE
static final String	JSON_PROPERTY_RESET_FACTORS
static final String	JSON_PROPERTY_RESET_PASSWORD
static final String	JSON_PROPERTY_SCHEMA
static final String	JSON_PROPERTY_SELF
static final String	JSON_PROPERTY_SUSPEND
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_UNLOCK
static final String	JSON_PROPERTY_UNSUSPEND

Constructor Summary

Constructors

Constructor	Description
UserLinks()

Method Summary

Modifier and Type	Method	Description
UserLinks	activate(HrefObject activate)
UserLinks	changePassword(HrefObject changePassword)
UserLinks	changeRecoveryQuestion(HrefObject changeRecoveryQuestion)
UserLinks	deactivate(HrefObject deactivate)
boolean	equals(Object o)
UserLinks	expirePassword(HrefObject expirePassword)
UserLinks	forgotPassword(HrefObject forgotPassword)
HrefObject	getActivate()	URL to activate the user
HrefObject	getChangePassword()	URL to change the User's password
HrefObject	getChangeRecoveryQuestion()	URL to change the User's recovery question
HrefObject	getDeactivate()	URL to deactivate a user
HrefObject	getExpirePassword()	URL to expire the User's password
HrefObject	getForgotPassword()	URL to initiate a forgot password operation
HrefObject	getReactivate()	URL to reactivate the user
HrefObject	getResetFactors()	URL to reset the User's factors
HrefObject	getResetPassword()	URL to reset the User's password
HrefObject	getSchema()	URL to the User's profile schema
HrefObject	getSelf()	URL to the individual user
HrefObject	getSuspend()	URL to suspend the user
HrefObject	getType()	URL to the User Type
HrefObject	getUnlock()	URL to unlock the locked-out user
HrefObject	getUnsuspend()	URL to unsuspend the user
int	hashCode()
UserLinks	reactivate(HrefObject reactivate)
UserLinks	resetFactors(HrefObject resetFactors)
UserLinks	resetPassword(HrefObject resetPassword)
UserLinks	schema(HrefObject schema)
UserLinks	self(HrefObject self)
void	setActivate(HrefObject activate)
void	setChangePassword(HrefObject changePassword)
void	setChangeRecoveryQuestion(HrefObject changeRecoveryQuestion)
void	setDeactivate(HrefObject deactivate)
void	setExpirePassword(HrefObject expirePassword)
void	setForgotPassword(HrefObject forgotPassword)
void	setReactivate(HrefObject reactivate)
void	setResetFactors(HrefObject resetFactors)
void	setResetPassword(HrefObject resetPassword)
void	setSchema(HrefObject schema)
void	setSelf(HrefObject self)
void	setSuspend(HrefObject suspend)
void	setType(HrefObject type)
void	setUnlock(HrefObject unlock)
void	setUnsuspend(HrefObject unsuspend)
UserLinks	suspend(HrefObject suspend)
String	toString()
UserLinks	type(HrefObject type)
UserLinks	unlock(HrefObject unlock)
UserLinks	unsuspend(HrefObject unsuspend)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_SELF

public static final String JSON_PROPERTY_SELF

See Also:

• Constant Field Values

JSON_PROPERTY_ACTIVATE

public static final String JSON_PROPERTY_ACTIVATE

See Also:

• Constant Field Values

JSON_PROPERTY_RESET_PASSWORD

public static final String JSON_PROPERTY_RESET_PASSWORD

See Also:

• Constant Field Values

JSON_PROPERTY_RESET_FACTORS

public static final String JSON_PROPERTY_RESET_FACTORS

See Also:

• Constant Field Values

JSON_PROPERTY_EXPIRE_PASSWORD

public static final String JSON_PROPERTY_EXPIRE_PASSWORD

See Also:

• Constant Field Values

JSON_PROPERTY_FORGOT_PASSWORD

public static final String JSON_PROPERTY_FORGOT_PASSWORD

See Also:

• Constant Field Values

JSON_PROPERTY_CHANGE_RECOVERY_QUESTION

public static final String JSON_PROPERTY_CHANGE_RECOVERY_QUESTION

See Also:

• Constant Field Values

JSON_PROPERTY_DEACTIVATE

public static final String JSON_PROPERTY_DEACTIVATE

See Also:

• Constant Field Values

JSON_PROPERTY_REACTIVATE

public static final String JSON_PROPERTY_REACTIVATE

See Also:

• Constant Field Values

JSON_PROPERTY_CHANGE_PASSWORD

public static final String JSON_PROPERTY_CHANGE_PASSWORD

See Also:

• Constant Field Values

JSON_PROPERTY_SCHEMA

public static final String JSON_PROPERTY_SCHEMA

See Also:

• Constant Field Values

JSON_PROPERTY_SUSPEND

public static final String JSON_PROPERTY_SUSPEND

See Also:

• Constant Field Values

JSON_PROPERTY_UNSUSPEND

public static final String JSON_PROPERTY_UNSUSPEND

See Also:

• Constant Field Values

JSON_PROPERTY_UNLOCK

public static final String JSON_PROPERTY_UNLOCK

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

UserLinks

public UserLinks()

Method Details

self

public UserLinks self(HrefObject self)

getSelf

@Nullable
public HrefObject getSelf()

URL to the individual user

Returns:

self

setSelf

public void setSelf(HrefObject self)

activate

public UserLinks activate(HrefObject activate)

getActivate

@Nullable
public HrefObject getActivate()

URL to activate the user

Returns:

activate

setActivate

public void setActivate(HrefObject activate)

resetPassword

public UserLinks resetPassword(HrefObject resetPassword)

getResetPassword

@Nullable
public HrefObject getResetPassword()

URL to reset the User's password

Returns:

resetPassword

setResetPassword

public void setResetPassword(HrefObject resetPassword)

resetFactors

public UserLinks resetFactors(HrefObject resetFactors)

getResetFactors

@Nullable
public HrefObject getResetFactors()

URL to reset the User's factors

Returns:

resetFactors

setResetFactors

public void setResetFactors(HrefObject resetFactors)

expirePassword

public UserLinks expirePassword(HrefObject expirePassword)

getExpirePassword

@Nullable
public HrefObject getExpirePassword()

URL to expire the User's password

Returns:

expirePassword

setExpirePassword

public void setExpirePassword(HrefObject expirePassword)

forgotPassword

public UserLinks forgotPassword(HrefObject forgotPassword)

getForgotPassword

@Nullable
public HrefObject getForgotPassword()

URL to initiate a forgot password operation

Returns:

forgotPassword

setForgotPassword

public void setForgotPassword(HrefObject forgotPassword)

changeRecoveryQuestion

public UserLinks changeRecoveryQuestion(HrefObject changeRecoveryQuestion)

getChangeRecoveryQuestion

@Nullable
public HrefObject getChangeRecoveryQuestion()

URL to change the User's recovery question

Returns:

changeRecoveryQuestion

setChangeRecoveryQuestion

public void setChangeRecoveryQuestion(HrefObject changeRecoveryQuestion)

deactivate

public UserLinks deactivate(HrefObject deactivate)

getDeactivate

@Nullable
public HrefObject getDeactivate()

URL to deactivate a user

Returns:

deactivate

setDeactivate

public void setDeactivate(HrefObject deactivate)

reactivate

public UserLinks reactivate(HrefObject reactivate)

getReactivate

@Nullable
public HrefObject getReactivate()

URL to reactivate the user

Returns:

reactivate

setReactivate

public void setReactivate(HrefObject reactivate)

changePassword

public UserLinks changePassword(HrefObject changePassword)

getChangePassword

@Nullable
public HrefObject getChangePassword()

URL to change the User's password

Returns:

changePassword

setChangePassword

public void setChangePassword(HrefObject changePassword)

schema

public UserLinks schema(HrefObject schema)

getSchema

@Nullable
public HrefObject getSchema()

URL to the User's profile schema

Returns:

schema

setSchema

public void setSchema(HrefObject schema)

suspend

public UserLinks suspend(HrefObject suspend)

getSuspend

@Nullable
public HrefObject getSuspend()

URL to suspend the user

Returns:

suspend

setSuspend

public void setSuspend(HrefObject suspend)

unsuspend

public UserLinks unsuspend(HrefObject unsuspend)

getUnsuspend

@Nullable
public HrefObject getUnsuspend()

URL to unsuspend the user

Returns:

unsuspend

setUnsuspend

public void setUnsuspend(HrefObject unsuspend)

unlock

public UserLinks unlock(HrefObject unlock)

getUnlock

@Nullable
public HrefObject getUnlock()

URL to unlock the locked-out user

Returns:

unlock

setUnlock

public void setUnlock(HrefObject unlock)

type

public UserLinks type(HrefObject type)

getType

@Nullable
public HrefObject getType()

URL to the User Type

Returns:

type

setType

public void setType(HrefObject type)

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