@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00") public class DefaultUser extends AbstractInstanceResource<User> implements User
deletedPropertyNames, dirty, dirtyProperties, properties, referenceFactoryreadLock, writeLock| Constructor and Description |
|---|
DefaultUser(InternalDataStore dataStore) |
DefaultUser(InternalDataStore dataStore,
Map<String,Object> properties) |
| Modifier and Type | Method and Description |
|---|---|
UserActivationToken |
activate(Boolean sendEmail)
Activate User
Activates a user.
|
Factor |
addFactor(Boolean updatePhone,
String templateId,
Factor body)
Enroll Factor
Enrolls a user with a supported [factor](#list-factors-to-enroll)
|
Factor |
addFactor(Factor body)
Enroll Factor
Enrolls a user with a supported [factor](#list-factors-to-enroll)
|
void |
addGroupTargetToRole(String roleId,
String groupId) |
Role |
addRole(Role role)
Assigns a role to a user.
|
void |
addToGroup(String groupId)
Add User to Group
Adds a [user](users.html#user-model) to a group with `OKTA_GROUP` type.
|
UserCredentials |
changePassword(ChangePasswordRequest changePasswordRequest)
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 |
deactivate()
Deactivate User
Deactivates a user.
|
void |
delete()
Delete User
Deletes a user permanently.
|
void |
endAllSessions()
Removes all active identity provider sessions.
|
void |
endAllSessions(Boolean oAuthTokens)
Removes all active identity provider sessions.
|
TempPassword |
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 |
expirePassword(Boolean tempPassword)
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.
|
ForgotPasswordResponse |
forgotPassword()
Forgot Password
Generates a one-time token (OTT) that can be used to reset a user's password.
|
ForgotPasswordResponse |
forgotPassword(Boolean sendEmail,
UserCredentials userCredentials)
Forgot Password
Generates a one-time token (OTT) that can be used to reset a user's password.
|
Date |
getActivated() |
Date |
getCreated() |
UserCredentials |
getCredentials() |
Map<String,Object> |
getEmbedded() |
Factor |
getFactor(String factorId)
Fetches a factor for the specified user
|
String |
getId() |
Date |
getLastLogin() |
Date |
getLastUpdated() |
Map<String,Object> |
getLinks() |
Date |
getPasswordChanged() |
UserProfile |
getProfile() |
Map<String,Property> |
getPropertyDescriptors() |
UserStatus |
getStatus() |
Date |
getStatusChanged() |
UserStatus |
getTransitioningToStatus() |
AppLinkList |
listAppLinks()
Get Assigned App Links
Fetches appLinks for all direct or indirect (via group membership) assigned applications.
|
AppLinkList |
listAppLinks(Boolean showAll)
Get Assigned App Links
Fetches appLinks for all direct or indirect (via group membership) assigned applications.
|
FactorList |
listFactors()
Enumerates all the enrolled factors for the specified user
|
GroupList |
listGroups()
Get Member Groups
Fetches the groups of which the user is a member.
|
GroupList |
listGroupTargetsForRole(String roleId) |
RoleList |
listRoles()
Lists all roles assigned to a user.
|
RoleList |
listRoles(String expand)
Lists all roles assigned to a user.
|
FactorList |
listSupportedFactors()
Enumerates all the [supported factors](#supported-factors-for-providers) that can be enrolled for the specified user
|
SecurityQuestionList |
listSupportedSecurityQuestions()
Enumerates all available security questions for a user's `question` factor
|
void |
removeGroupTargetFromRole(String roleId,
String groupId) |
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()
Reset Password
Generates a one-time token (OTT) that can be used to reset a user's password.
|
ResetPasswordToken |
resetPassword(String provider,
Boolean sendEmail)
Reset Password
Generates a one-time token (OTT) that can be used to reset a user's password.
|
User |
setCredentials(UserCredentials credentials) |
User |
setProfile(UserProfile profile) |
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.
|
isInstanceResource, saveclear, containsKey, containsValue, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isMaterialized, isMaterialized, isNew, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, setResourceProperty, size, toString, valuesgetBoolean, getBoolean, getBooleanProperty, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setPropertyclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetResourceHref, setResourceHrefpublic DefaultUser(InternalDataStore dataStore)
public DefaultUser(InternalDataStore dataStore, Map<String,Object> properties)
public Map<String,Property> getPropertyDescriptors()
getPropertyDescriptors in class AbstractResourcepublic Map<String,Object> getEmbedded()
getEmbedded in interface Userpublic Date getActivated()
getActivated in interface Userpublic Date getCreated()
getCreated in interface Userpublic UserCredentials getCredentials()
getCredentials in interface Userpublic User setCredentials(UserCredentials credentials)
setCredentials in interface Userpublic Date getLastLogin()
getLastLogin in interface Userpublic Date getLastUpdated()
getLastUpdated in interface Userpublic Date getPasswordChanged()
getPasswordChanged in interface Userpublic UserProfile getProfile()
getProfile in interface Userpublic User setProfile(UserProfile profile)
setProfile in interface Userpublic UserStatus getStatus()
public Date getStatusChanged()
getStatusChanged in interface Userpublic UserStatus getTransitioningToStatus()
getTransitioningToStatus in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/deactivate") public void deactivate()
deactivate in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/reset_password") public ResetPasswordToken resetPassword(String provider, Boolean sendEmail)
resetPassword in interface Userprovider - (optional)sendEmail - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/reset_password") public ResetPasswordToken resetPassword()
resetPassword in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/factors") public FactorList listFactors()
listFactors in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/groups") public GroupList listGroupTargetsForRole(String roleId)
listGroupTargetsForRole in interface UserroleId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/credentials/forgot_password") public ForgotPasswordResponse forgotPassword(Boolean sendEmail, UserCredentials userCredentials)
forgotPassword in interface UsersendEmail - (optional, default to true)userCredentials - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/credentials/forgot_password") public ForgotPasswordResponse forgotPassword()
forgotPassword in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="DELETE - /api/v1/users/{userId}/roles/{roleId}") public void removeRole(String roleId)
removeRole in interface UserroleId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/expire_password") public TempPassword expirePassword(Boolean tempPassword)
expirePassword in interface UsertempPassword - Sets the user's password to a temporary password, if true (optional, default to false)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/expire_password") public TempPassword expirePassword()
expirePassword in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/activate") public UserActivationToken activate(Boolean sendEmail)
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/credentials/change_recovery_question") public UserCredentials changeRecoveryQuestion(UserCredentials userCredentials)
changeRecoveryQuestion in interface UseruserCredentials - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/unsuspend") public void unsuspend()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/factors") public Factor addFactor(Boolean updatePhone, String templateId, Factor body)
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/factors") public Factor addFactor(Factor body)
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/groups") public GroupList listGroups()
listGroups in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}") public void removeGroupTargetFromRole(String roleId, String groupId)
removeGroupTargetFromRole in interface UserroleId - (required)groupId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/factors/catalog") public FactorList listSupportedFactors()
listSupportedFactors in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="DELETE - /api/v1/users/{userId}") public void delete()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/reset_factors") public void resetFactors()
resetFactors in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/suspend") public void suspend()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/roles") public RoleList listRoles(String expand)
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/roles") public RoleList listRoles()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/lifecycle/unlock") public void unlock()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="PUT - /api/v1/users/{userId}") public User update()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/factors/{factorId}") public Factor getFactor(String factorId)
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="POST - /api/v1/users/{userId}/credentials/change_password") public UserCredentials changePassword(ChangePasswordRequest changePasswordRequest)
changePassword in interface UserchangePasswordRequest - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/appLinks") public AppLinkList listAppLinks(Boolean showAll)
listAppLinks in interface UsershowAll - (optional, default to false)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/appLinks") public AppLinkList listAppLinks()
listAppLinks in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}") public void addGroupTargetToRole(String roleId, String groupId)
addGroupTargetToRole in interface UserroleId - (required)groupId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="GET - /api/v1/users/{userId}/factors/questions") public SecurityQuestionList listSupportedSecurityQuestions()
listSupportedSecurityQuestions in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="DELETE - /api/v1/users/{userId}/sessions") public void endAllSessions(Boolean oAuthTokens)
endAllSessions in interface UseroAuthTokens - Revoke issued OpenID Connect and OAuth refresh and access tokens (optional, default to false)@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="DELETE - /api/v1/users/{userId}/sessions") public void endAllSessions()
endAllSessions in interface User@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen", date="2017-12-14T13:01:44.308-05:00", comments="PUT - /api/v1/groups/{groupId}/users/{userId}") public void addToGroup(String groupId)
addToGroup in interface UsergroupId - (required)Copyright © 2017 Okta. All rights reserved.