docs.UserLinks.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation

The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

There is a newer version: 21.0.0

Show newest version



# UserLinks

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.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**self** | **HrefObject** | URL to the individual user |  [optional] |
|**activate** | **HrefObject** | URL to activate the user |  [optional] |
|**resetPassword** | **HrefObject** | URL to reset the User's password |  [optional] |
|**resetFactors** | **HrefObject** | URL to reset the User's factors |  [optional] |
|**expirePassword** | **HrefObject** | URL to expire the User's password |  [optional] |
|**forgotPassword** | **HrefObject** | URL to initiate a forgot password operation |  [optional] |
|**changeRecoveryQuestion** | **HrefObject** | URL to change the User's recovery question |  [optional] |
|**deactivate** | **HrefObject** | URL to deactivate a user |  [optional] |
|**reactivate** | **HrefObject** | URL to reactivate the user |  [optional] |
|**changePassword** | **HrefObject** | URL to change the User's password |  [optional] |
|**schema** | **HrefObject** | URL to the User's profile schema |  [optional] |
|**suspend** | **HrefObject** | URL to suspend the user |  [optional] |
|**unsuspend** | **HrefObject** | URL to unsuspend the user |  [optional] |
|**unlock** | **HrefObject** | URL to unlock the locked-out user |  [optional] |
|**type** | **HrefObject** | URL to the User Type |  [optional] |


## Implemented Interfaces

* Serializable