DefaultUser (Okta Java SDK 8.2.5 API)

java.lang.Object
- com.okta.sdk.impl.resource.AbstractPropertyRetriever
- - com.okta.sdk.impl.resource.AbstractResource
  - - com.okta.sdk.impl.resource.AbstractInstanceResource<User>
    - - com.okta.sdk.impl.resource.user.DefaultUser

All Implemented Interfaces:: Deletable, ExtensibleResource, PropertyRetriever, Resource, Saveable<User>, User, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultUser
extends AbstractInstanceResource<User>
implements User

User

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.okta.sdk.impl.resource.AbstractResource
  properties
- Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever
  readLock, writeLock

Constructor Summary

Constructors
Constructor and Description

DefaultUser(InternalDataStore dataStore)

DefaultUser(InternalDataStore dataStore, Map<String,Object> properties)

Constructors
Constructor and Description
`DefaultUser(InternalDataStore dataStore)`
`DefaultUser(InternalDataStore dataStore, Map<String,Object> properties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserActivationToken`	`activate(Boolean sendEmail)` Activate User Activates a user.
`void`	`addAllAppsAsTarget(String roleId)` Success
`void`	`addGroupTarget(String roleId, String groupId)` Success
`void`	`addToGroup(String groupId)` Add User to Group Adds a user to a group with 'OKTA_GROUP' type.
`Role`	`assignRole(AssignRoleRequest assignRoleRequest)` Assigns a role to a user.
`Role`	`assignRole(AssignRoleRequest assignRoleRequest, Boolean disableNotifications)` Assigns a role to a user.
`UserCredentials`	`changePassword(ChangePasswordRequest changePasswordRequest)` Change Password Changes a user's password by validating the user's current password.
`UserCredentials`	`changePassword(ChangePasswordRequest changePasswordRequest, Boolean strict)` Change Password Changes a user's password by validating the user's current password.
`UserCredentials`	`changeRecoveryQuestion(UserCredentials userCredentials)` Change Recovery Question Changes a user's recovery question & answer credential by validating the user's current password.
`void`	`clearSessions()` Removes all active identity provider sessions.
`void`	`clearSessions(Boolean oAuthTokens)` Removes all active identity provider sessions.
`void`	`deactivate()` Deactivate User Deactivates a user.
`void`	`deactivate(Boolean sendEmail)` Deactivate User Deactivates a user.
`void`	`delete()` Delete User Deletes a user permanently.
`void`	`delete(Boolean sendEmail)` Delete User Deletes a user permanently.
`void`	`deleteFactor(String factorId)` Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
`UserFactor`	`enrollFactor(UserFactor body)` Enroll Factor Enrolls a user with a supported factor.
`UserFactor`	`enrollFactor(UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate)` Enroll Factor Enrolls a user with a supported factor.
`User`	`expirePassword()` Expire Password This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login.
`TempPassword`	`expirePasswordAndGetTemporaryPassword()` Expire Password This operation transitions the user to the status of `PASSWORD_EXPIRED` and the user's password is reset to a temporary password that is returned.
`ForgotPasswordResponse`	`forgotPasswordGenerateOneTimeToken()` Forgot Password Generates a one-time token (OTT) that can be used to reset a user's password
`ForgotPasswordResponse`	`forgotPasswordGenerateOneTimeToken(Boolean sendEmail)` Forgot Password Generates a one-time token (OTT) that can be used to reset a user's password
`ForgotPasswordResponse`	`forgotPasswordSetNewPassword(UserCredentials user)` Forgot Password Sets a new password for a user by validating the user's answer to their current recovery question
`ForgotPasswordResponse`	`forgotPasswordSetNewPassword(UserCredentials user, Boolean sendEmail)` Forgot Password Sets a new password for a user by validating the user's answer to their current recovery question
`Date`	`getActivated()`
`Date`	`getCreated()`
`UserCredentials`	`getCredentials()`
`Map<String,Object>`	`getEmbedded()`
`UserFactor`	`getFactor(String factorId)` Fetches a factor for the specified user
`String`	`getId()`
`Date`	`getLastLogin()`
`Date`	`getLastUpdated()`
`ResponseLinksList`	`getLinkedObjects(String relationshipName)` Get linked objects for a user, relationshipName can be a primary or associated relationship name
`Map<String,Object>`	`getLinks()`
`Date`	`getPasswordChanged()`
`UserProfile`	`getProfile()`
`Map<String,Property>`	`getPropertyDescriptors()`
`OAuth2RefreshToken`	`getRefreshTokenForUserAndClient(String clientId, String tokenId)` Gets a refresh token issued for the specified User and Client.
`OAuth2RefreshToken`	`getRefreshTokenForUserAndClient(String clientId, String tokenId, String expand)` Gets a refresh token issued for the specified User and Client.
`Class<? extends Resource>`	`getResourceClass()` Returns the class this resource represents.
`Role`	`getRole(String roleId)` Gets role that is assigne to user.
`UserStatus`	`getStatus()`
`Date`	`getStatusChanged()`
`UserStatus`	`getTransitioningToStatus()`
`UserType`	`getType()`
`AppLinkList`	`listAppLinks()` Get Assigned App Links Fetches appLinks for all direct or indirect (via group membership) assigned applications.
`RoleList`	`listAssignedRoles()` Lists all roles assigned to a user.
`RoleList`	`listAssignedRoles(String expand)` Lists all roles assigned to a user.
`OAuth2ClientList`	`listClients()` Lists all client resources for which the specified user has grants or tokens.
`UserFactorList`	`listFactors()` Enumerates all the enrolled factors for the specified user
`OAuth2ScopeConsentGrantList`	`listGrants()` Lists all grants for the specified user
`OAuth2ScopeConsentGrantList`	`listGrants(String scopeId, String expand)` Lists all grants for the specified user
`GroupList`	`listGroups()` Get Member Groups Fetches the groups of which the user is a member.
`GroupList`	`listGroupTargets(String roleId)` Success
`IdentityProviderList`	`listIdentityProviders()` Listing IdPs associated with a user Lists the IdPs associated with the user.
`OAuth2RefreshTokenList`	`listRefreshTokensForUserAndClient(String clientId)` Lists all refresh tokens issued for the specified User and Client.
`OAuth2RefreshTokenList`	`listRefreshTokensForUserAndClient(String clientId, String expand)` Lists all refresh tokens issued for the specified User and Client.
`UserFactorList`	`listSupportedFactors()` Enumerates all the supported factors that can be enrolled for the specified user
`SecurityQuestionList`	`listSupportedSecurityQuestions()` Enumerates all available security questions for a user's `question` factor
`UserActivationToken`	`reactivate()` Reactivate User Reactivates a user.
`UserActivationToken`	`reactivate(Boolean sendEmail)` Reactivate User Reactivates a user.
`void`	`removeGroupTarget(String roleId, String groupId)` Success
`void`	`removeLinkedObject(String relationshipName)` Delete linked objects for a user, relationshipName can be ONLY a primary relationship name
`void`	`removeRole(String roleId)` Unassigns a role from a user.
`void`	`resetFactors()` Reset Factors This operation resets all factors for the specified user.
`ResetPasswordToken`	`resetPassword(Boolean sendEmail)` Reset Password Generates a one-time token (OTT) that can be used to reset a user's password.
`void`	`revokeGrant(String grantId)` Revokes one grant for a specified user
`void`	`revokeGrants()` Revokes all grants for a specified user
`void`	`revokeGrantsForUserAndClient(String clientId)` Revokes all grants for the specified user and client
`void`	`revokeTokenForUserAndClient(String clientId, String tokenId)` Revokes the specified refresh token.
`void`	`revokeTokensForUserAndClient(String clientId)` Revokes all refresh tokens issued for the specified User and Client.
`User`	`setCredentials(UserCredentials credentials)`
`void`	`setLinkedObject(String primaryRelationshipName, String primaryUserId)`
`User`	`setProfile(UserProfile profile)`
`User`	`setType(UserType type)`
`void`	`suspend()` Suspend User Suspends a user.
`void`	`unlock()` Unlock User Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status.
`void`	`unsuspend()` Unsuspend User Unsuspends a user and returns them to the `ACTIVE` state.
`User`	`update()` Update User Update a user's profile and/or credentials using strict-update semantics.
`User`	`update(Boolean strict)` Update User Update a user's profile and/or credentials using strict-update semantics.

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource
save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource
clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever
getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.okta.sdk.resource.Resource
getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever
getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultUser

public DefaultUser(InternalDataStore dataStore)

DefaultUser

public DefaultUser(InternalDataStore dataStore,
                   Map<String,Object> properties)

Method Detail

getPropertyDescriptors
```
public Map<String,Property> getPropertyDescriptors()
```
Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass
```
public Class<? extends Resource> getResourceClass()
```
Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<User>

Returns:

The type of resource this class represents.

getEmbedded
```
public Map<String,Object> getEmbedded()
```
Specified by:

getEmbedded in interface User

getLinks
```
public Map<String,Object> getLinks()
```
Specified by:

getLinks in interface User

getActivated
```
public Date getActivated()
```
Specified by:

getActivated in interface User

getCreated
```
public Date getCreated()
```
Specified by:

getCreated in interface User

getCredentials
```
public UserCredentials getCredentials()
```
Specified by:

getCredentials in interface User

setCredentials

public User setCredentials(UserCredentials credentials)

Specified by:: setCredentials in interface User

getId
```
public String getId()
```
Specified by:

getId in interface User

getLastLogin
```
public Date getLastLogin()
```
Specified by:

getLastLogin in interface User

getLastUpdated
```
public Date getLastUpdated()
```
Specified by:

getLastUpdated in interface User

getPasswordChanged
```
public Date getPasswordChanged()
```
Specified by:

getPasswordChanged in interface User

getProfile
```
public UserProfile getProfile()
```
Specified by:

getProfile in interface User

setProfile

public User setProfile(UserProfile profile)

Specified by:: setProfile in interface User

getStatus
```
public UserStatus getStatus()
```
Specified by:

getStatus in interface User

getStatusChanged
```
public Date getStatusChanged()
```
Specified by:

getStatusChanged in interface User

getTransitioningToStatus
```
public UserStatus getTransitioningToStatus()
```
Specified by:

getTransitioningToStatus in interface User

getType
```
public UserType getType()
```
Specified by:

getType in interface User

setType
```
public User setType(UserType type)
```
Specified by:

setType in interface User

listIdentityProviders

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/idps")
public IdentityProviderList listIdentityProviders()

Listing IdPs associated with a user Lists the IdPs associated with the user.

Specified by:: listIdentityProviders in interface User
Returns:: IdentityProviderList

deactivate
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/deactivate")
public void deactivate(Boolean sendEmail)
```
Deactivate User Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. While the asynchronous operation (triggered by HTTP header `Prefer: respond-async`) is proceeding the user's `transitioningToStatus` property is `DEPROVISIONED`. The user's status is `DEPROVISIONED` when the deactivation process is complete.

Specified by:

deactivate in interface User

Parameters:

sendEmail - (optional, default to false)

deactivate
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/deactivate")
public void deactivate()
```
Deactivate User Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. While the asynchronous operation (triggered by HTTP header `Prefer: respond-async`) is proceeding the user's `transitioningToStatus` property is `DEPROVISIONED`. The user's status is `DEPROVISIONED` when the deactivation process is complete.

Specified by:

deactivate in interface User

resetPassword
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reset_password")
public ResetPasswordToken resetPassword(Boolean sendEmail)
```
Reset Password Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow.

Specified by:

resetPassword in interface User

Parameters:

sendEmail - (required)

Returns:

ResetPasswordToken

expirePasswordAndGetTemporaryPassword

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/expire_password?tempPassword&#x3D;true")
public TempPassword expirePasswordAndGetTemporaryPassword()

Expire Password This operation transitions the user to the status of `PASSWORD_EXPIRED` and the user's password is reset to a temporary password that is returned.

Specified by:: expirePasswordAndGetTemporaryPassword in interface User
Returns:: TempPassword

enrollFactor

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/factors")
public UserFactor enrollFactor(UserFactor body,
                                                                                                                                                                                                                    Boolean updatePhone,
                                                                                                                                                                                                                    String templateId,
                                                                                                                                                                                                                    Integer tokenLifetimeSeconds,
                                                                                                                                                                                                                    Boolean activate)

Enroll Factor Enrolls a user with a supported factor.

Specified by:: enrollFactor in interface User
Parameters:: body - Factor (required); updatePhone - (optional, default to false); templateId - id of SMS template (only for SMS factor) (optional); tokenLifetimeSeconds - (optional, default to 300); activate - (optional, default to false)
Returns:: UserFactor

enrollFactor

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/factors")
public UserFactor enrollFactor(UserFactor body)

Enroll Factor Enrolls a user with a supported factor.

Specified by:: enrollFactor in interface User
Parameters:: body - Factor (required)
Returns:: UserFactor

listFactors

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/factors")
public UserFactorList listFactors()

Enumerates all the enrolled factors for the specified user

Specified by:: listFactors in interface User
Returns:: UserFactorList

forgotPasswordGenerateOneTimeToken

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
public ForgotPasswordResponse forgotPasswordGenerateOneTimeToken(Boolean sendEmail)

Forgot Password Generates a one-time token (OTT) that can be used to reset a user's password

Specified by:: forgotPasswordGenerateOneTimeToken in interface User
Parameters:: sendEmail - (optional, default to true)
Returns:: ForgotPasswordResponse

forgotPasswordGenerateOneTimeToken

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
public ForgotPasswordResponse forgotPasswordGenerateOneTimeToken()

Forgot Password Generates a one-time token (OTT) that can be used to reset a user's password

Specified by:: forgotPasswordGenerateOneTimeToken in interface User
Returns:: ForgotPasswordResponse

clearSessions
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/sessions")
public void clearSessions(Boolean oAuthTokens)
```
Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

Specified by:

clearSessions in interface User

Parameters:

oAuthTokens - Revoke issued OpenID Connect and OAuth refresh and access tokens (optional, default to false)

clearSessions
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/sessions")
public void clearSessions()
```
Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

Specified by:

clearSessions in interface User

addAllAppsAsTarget

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
public void addAllAppsAsTarget(String roleId)

Success

Specified by:: addAllAppsAsTarget in interface User
Parameters:: roleId - (required)

forgotPasswordSetNewPassword

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
public ForgotPasswordResponse forgotPasswordSetNewPassword(UserCredentials user,
                                                                                                                                                                                                                                                                    Boolean sendEmail)

Forgot Password Sets a new password for a user by validating the user's answer to their current recovery question

Specified by:: forgotPasswordSetNewPassword in interface User
Parameters:: user - (required); sendEmail - (optional, default to true)
Returns:: ForgotPasswordResponse

forgotPasswordSetNewPassword

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
public ForgotPasswordResponse forgotPasswordSetNewPassword(UserCredentials user)

Forgot Password Sets a new password for a user by validating the user's answer to their current recovery question

Specified by:: forgotPasswordSetNewPassword in interface User
Parameters:: user - (required)
Returns:: ForgotPasswordResponse

revokeTokensForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/tokens")
public void revokeTokensForUserAndClient(String clientId)

Revokes all refresh tokens issued for the specified User and Client.

Specified by:: revokeTokensForUserAndClient in interface User
Parameters:: clientId - (required)

resetFactors
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reset_factors")
public void resetFactors()
```
Reset Factors This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors.

Specified by:

resetFactors in interface User

getLinkedObjects

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/linkedObjects/{relationshipName}")
public ResponseLinksList getLinkedObjects(String relationshipName)

Get linked objects for a user, relationshipName can be a primary or associated relationship name

Specified by:: getLinkedObjects in interface User
Parameters:: relationshipName - (required)
Returns:: ResponseLinksList

revokeGrants

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/grants")
public void revokeGrants()

Revokes all grants for a specified user

Specified by:: revokeGrants in interface User

listGroupTargets

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/groups")
public GroupList listGroupTargets(String roleId)

Success

Specified by:: listGroupTargets in interface User
Parameters:: roleId - (required)
Returns:: GroupList

getRefreshTokenForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
public OAuth2RefreshToken getRefreshTokenForUserAndClient(String clientId,
                                                                                                                                                                                                                                                                          String tokenId,
                                                                                                                                                                                                                                                                          String expand)

Gets a refresh token issued for the specified User and Client.

Specified by:: getRefreshTokenForUserAndClient in interface User
Parameters:: clientId - (required); tokenId - (required); expand - (optional)
Returns:: OAuth2RefreshToken

getRefreshTokenForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
public OAuth2RefreshToken getRefreshTokenForUserAndClient(String clientId,
                                                                                                                                                                                                                                                                          String tokenId)

Gets a refresh token issued for the specified User and Client.

Specified by:: getRefreshTokenForUserAndClient in interface User
Parameters:: clientId - (required); tokenId - (required)
Returns:: OAuth2RefreshToken

revokeGrantsForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/grants")
public void revokeGrantsForUserAndClient(String clientId)

Revokes all grants for the specified user and client

Specified by:: revokeGrantsForUserAndClient in interface User
Parameters:: clientId - (required)

removeRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}")
public void removeRole(String roleId)

Unassigns a role from a user.

Specified by:: removeRole in interface User
Parameters:: roleId - (required)

revokeTokenForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
public void revokeTokenForUserAndClient(String clientId,
                                                                                                                                                                                                                                                           String tokenId)

Revokes the specified refresh token.

Specified by:: revokeTokenForUserAndClient in interface User
Parameters:: clientId - (required); tokenId - (required)

expirePassword

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/expire_password?tempPassword&#x3D;false")
public User expirePassword()

Expire Password This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login.

Specified by:: expirePassword in interface User
Returns:: User

activate
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/activate")
public UserActivationToken activate(Boolean sendEmail)
```
Activate User Activates a user. This operation can only be performed on users with a `STAGED` status. Activation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `ACTIVE` when the activation process is complete.

Specified by:

activate in interface User

Parameters:

sendEmail - Sends an activation email to the user if true (required)

Returns:

UserActivationToken

changeRecoveryQuestion
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/change_recovery_question")
public UserCredentials changeRecoveryQuestion(UserCredentials userCredentials)
```
Change Recovery Question Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password credential

Specified by:

changeRecoveryQuestion in interface User

Parameters:

userCredentials - (required)

Returns:

UserCredentials

listGrants

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/grants")
public OAuth2ScopeConsentGrantList listGrants(String scopeId,
                                                                                                                                                                                                                                 String expand)

Lists all grants for the specified user

Specified by:: listGrants in interface User
Parameters:: scopeId - (optional); expand - (optional)
Returns:: OAuth2ScopeConsentGrantList

listGrants

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/grants")
public OAuth2ScopeConsentGrantList listGrants()

Lists all grants for the specified user

Specified by:: listGrants in interface User
Returns:: OAuth2ScopeConsentGrantList

unsuspend

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/unsuspend")
public void unsuspend()

Unsuspend User Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status.

Specified by:: unsuspend in interface User

assignRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/roles")
public Role assignRole(AssignRoleRequest assignRoleRequest,
                                                                                                                                                                                                          Boolean disableNotifications)

Assigns a role to a user.

Specified by:: assignRole in interface User
Parameters:: assignRoleRequest - (required); disableNotifications - (optional)
Returns:: Role

assignRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/roles")
public Role assignRole(AssignRoleRequest assignRoleRequest)

Assigns a role to a user.

Specified by:: assignRole in interface User
Parameters:: assignRoleRequest - (required)
Returns:: Role

getRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}")
public Role getRole(String roleId)

Gets role that is assigne to user.

Specified by:: getRole in interface User
Parameters:: roleId - (required)
Returns:: Role

listGroups

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/groups")
public GroupList listGroups()

Get Member Groups Fetches the groups of which the user is a member.

Specified by:: listGroups in interface User
Returns:: GroupList

listRefreshTokensForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens")
public OAuth2RefreshTokenList listRefreshTokensForUserAndClient(String clientId,
                                                                                                                                                                                                                                                                      String expand)

Lists all refresh tokens issued for the specified User and Client.

Specified by:: listRefreshTokensForUserAndClient in interface User
Parameters:: clientId - (required); expand - (optional)
Returns:: OAuth2RefreshTokenList

listRefreshTokensForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens")
public OAuth2RefreshTokenList listRefreshTokensForUserAndClient(String clientId)

Lists all refresh tokens issued for the specified User and Client.

Specified by:: listRefreshTokensForUserAndClient in interface User
Parameters:: clientId - (required)
Returns:: OAuth2RefreshTokenList

removeGroupTarget

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}")
public void removeGroupTarget(String roleId,
                                                                                                                                                                                                                                                     String groupId)

Success

Specified by:: removeGroupTarget in interface User
Parameters:: roleId - (required); groupId - (required)

listSupportedFactors

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/factors/catalog")
public UserFactorList listSupportedFactors()

Enumerates all the supported factors that can be enrolled for the specified user

Specified by:: listSupportedFactors in interface User
Returns:: UserFactorList

delete
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}")
public void delete(Boolean sendEmail)
```
Delete User Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**

Specified by:

delete in interface User

Parameters:

sendEmail - (optional, default to false)

delete
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}")
public void delete()
```
Delete User Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**

Specified by:

delete in interface Deletable

Specified by:

delete in interface User

Overrides:

delete in class AbstractInstanceResource<User>

listClients

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/clients")
public OAuth2ClientList listClients()

Lists all client resources for which the specified user has grants or tokens.

Specified by:: listClients in interface User
Returns:: OAuth2ClientList

suspend

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/suspend")
public void suspend()

Suspend User Suspends a user. This operation can only be performed on users with an `ACTIVE` status. The user will have a status of `SUSPENDED` when the process is complete.

Specified by:: suspend in interface User

revokeGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/grants/{grantId}")
public void revokeGrant(String grantId)

Revokes one grant for a specified user

Specified by:: revokeGrant in interface User
Parameters:: grantId - (required)

setLinkedObject

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}")
public void setLinkedObject(String primaryRelationshipName,
                                                                                                                                                                                                                                                                          String primaryUserId)

Specified by:: setLinkedObject in interface User
Parameters:: primaryRelationshipName - (required); primaryUserId - (required)

removeLinkedObject

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/linkedObjects/{relationshipName}")
public void removeLinkedObject(String relationshipName)

Delete linked objects for a user, relationshipName can be ONLY a primary relationship name

Specified by:: removeLinkedObject in interface User
Parameters:: relationshipName - (required)

unlock

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/unlock")
public void unlock()

Unlock User Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status. Users will be able to login with their current password.

Specified by:: unlock in interface User

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}")
public User update(Boolean strict)

Update User Update a user's profile and/or credentials using strict-update semantics.

Specified by:: update in interface User
Parameters:: strict - (optional)
Returns:: User

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}")
public User update()

Update User Update a user's profile and/or credentials using strict-update semantics.

Specified by:: update in interface User
Returns:: User

deleteFactor

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/factors/{factorId}")
public void deleteFactor(String factorId)

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

Specified by:: deleteFactor in interface User
Parameters:: factorId - (required)

reactivate
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reactivate")
public UserActivationToken reactivate(Boolean sendEmail)
```
Reactivate User Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user).

Specified by:

reactivate in interface User

Parameters:

sendEmail - Sends an activation email to the user if true (optional, default to false)

Returns:

UserActivationToken

reactivate
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reactivate")
public UserActivationToken reactivate()
```
Reactivate User Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user).

Specified by:

reactivate in interface User

Returns:

UserActivationToken

getFactor

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/factors/{factorId}")
public UserFactor getFactor(String factorId)

Fetches a factor for the specified user

Specified by:: getFactor in interface User
Parameters:: factorId - (required)
Returns:: UserFactor

changePassword

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/change_password")
public UserCredentials changePassword(ChangePasswordRequest changePasswordRequest,
                                                                                                                                                                                                                                               Boolean strict)

Change Password Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential

Specified by:: changePassword in interface User
Parameters:: changePasswordRequest - (required); strict - (optional)
Returns:: UserCredentials

changePassword
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/credentials/change_password")
public UserCredentials changePassword(ChangePasswordRequest changePasswordRequest)
```
Change Password Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential

Specified by:

changePassword in interface User

Parameters:

changePasswordRequest - (required)

Returns:

UserCredentials

listAppLinks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/appLinks")
public AppLinkList listAppLinks()

Get Assigned App Links Fetches appLinks for all direct or indirect (via group membership) assigned applications.

Specified by:: listAppLinks in interface User
Returns:: AppLinkList

addGroupTarget

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}")
public void addGroupTarget(String roleId,
                                                                                                                                                                                                                                               String groupId)

Success

Specified by:: addGroupTarget in interface User
Parameters:: roleId - (required); groupId - (required)

listSupportedSecurityQuestions

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/factors/questions")
public SecurityQuestionList listSupportedSecurityQuestions()

Enumerates all available security questions for a user's `question` factor

Specified by:: listSupportedSecurityQuestions in interface User
Returns:: SecurityQuestionList

addToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/groups/{groupId}/users/{userId}")
public void addToGroup(String groupId)

Add User to Group Adds a user to a group with 'OKTA_GROUP' type.

Specified by:: addToGroup in interface User
Parameters:: groupId - (required)

listAssignedRoles

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/roles")
public RoleList listAssignedRoles(String expand)

Lists all roles assigned to a user.

Specified by:: listAssignedRoles in interface User
Parameters:: expand - (optional)
Returns:: RoleList

listAssignedRoles

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/users/{userId}/roles")
public RoleList listAssignedRoles()

Lists all roles assigned to a user.

Specified by:: listAssignedRoles in interface User
Returns:: RoleList

Class DefaultUser

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

Constructor Summary

Method Summary

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

Methods inherited from class java.lang.Object

Methods inherited from interface com.okta.sdk.resource.Resource

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

Methods inherited from interface java.util.Map

Constructor Detail

DefaultUser

DefaultUser

Method Detail

getPropertyDescriptors

getResourceClass

getEmbedded

getLinks

getActivated

getCreated

getCredentials

setCredentials

getId

getLastLogin

getLastUpdated

getPasswordChanged

getProfile

setProfile

getStatus

getStatusChanged

getTransitioningToStatus

getType

setType

listIdentityProviders

deactivate

deactivate

resetPassword

expirePasswordAndGetTemporaryPassword

enrollFactor

enrollFactor

listFactors

forgotPasswordGenerateOneTimeToken

forgotPasswordGenerateOneTimeToken

clearSessions

clearSessions

addAllAppsAsTarget

forgotPasswordSetNewPassword

forgotPasswordSetNewPassword

revokeTokensForUserAndClient

resetFactors

getLinkedObjects

revokeGrants

listGroupTargets

getRefreshTokenForUserAndClient

getRefreshTokenForUserAndClient

revokeGrantsForUserAndClient

removeRole

revokeTokenForUserAndClient

expirePassword

activate

changeRecoveryQuestion

listGrants

listGrants

unsuspend

assignRole

assignRole

getRole

listGroups

listRefreshTokensForUserAndClient

listRefreshTokensForUserAndClient

removeGroupTarget

listSupportedFactors

delete

delete

listClients