Package com.okta.sdk.resource.user

Interface User

    • Method Detail

      • getEmbedded

        java.util.Map<java.lang.String,​java.lang.Object> getEmbedded()

      • getLinks

        java.util.Map<java.lang.String,​java.lang.Object> getLinks()

      • getActivated

        java.util.Date getActivated()

      • getCreated

        java.util.Date getCreated()

      • getId

        java.lang.String getId()

      • getLastLogin

        java.util.Date getLastLogin()

      • getLastUpdated

        java.util.Date getLastUpdated()

      • getPasswordChanged

        java.util.Date getPasswordChanged()

      • getStatusChanged

        java.util.Date getStatusChanged()

      • getTransitioningToStatus

        UserStatus getTransitioningToStatus()

      • listIdentityProviders

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/idps")
IdentityProviderList listIdentityProviders()
        Listing IdPs associated with a user Lists the IdPs associated with the user.
        Returns:
        IdentityProviderList

      • deactivate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/deactivate")
void deactivate​(java.lang.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.
        Parameters:
        sendEmail - (optional, default to false)

      • deactivate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/deactivate")
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.

      • resetPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reset_password")
ResetPasswordToken resetPassword​(java.lang.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.
        Parameters:
        sendEmail - (required)
        Returns:
        ResetPasswordToken

      • expirePasswordAndGetTemporaryPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/expire_password?tempPassword&#x3D;true")
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.
        Returns:
        TempPassword

      • enrollFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/factors")
UserFactor enrollFactor​(UserFactor body,
                        java.lang.Boolean updatePhone,
                        java.lang.String templateId,
                        java.lang.Integer tokenLifetimeSeconds,
                        java.lang.Boolean activate)
        Enroll Factor Enrolls a user with a supported factor.
        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.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/factors")
UserFactor enrollFactor​(UserFactor body)
        Enroll Factor Enrolls a user with a supported factor.
        Parameters:
        body - Factor (required)
        Returns:
        UserFactor

      • listFactors

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/factors")
UserFactorList listFactors()
        Enumerates all the enrolled factors for the specified user
        Returns:
        UserFactorList

      • forgotPasswordGenerateOneTimeToken

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
ForgotPasswordResponse forgotPasswordGenerateOneTimeToken​(java.lang.Boolean sendEmail)
        Forgot Password Generates a one-time token (OTT) that can be used to reset a user's password
        Parameters:
        sendEmail - (optional, default to true)
        Returns:
        ForgotPasswordResponse

      • forgotPasswordGenerateOneTimeToken

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
ForgotPasswordResponse forgotPasswordGenerateOneTimeToken()
        Forgot Password Generates a one-time token (OTT) that can be used to reset a user's password
        Returns:
        ForgotPasswordResponse

      • clearSessions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/sessions")
void clearSessions​(java.lang.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.
        Parameters:
        oAuthTokens - Revoke issued OpenID Connect and OAuth refresh and access tokens (optional, default to false)

      • clearSessions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/sessions")
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.

      • addAllAppsAsTarget

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
void addAllAppsAsTarget​(java.lang.String roleId)
        Success
        Parameters:
        roleId - (required)

      • forgotPasswordSetNewPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
ForgotPasswordResponse forgotPasswordSetNewPassword​(UserCredentials user,
                                                    java.lang.Boolean sendEmail)
        Forgot Password Sets a new password for a user by validating the user's answer to their current recovery question
        Parameters:
        user - (required)
        sendEmail - (optional, default to true)
        Returns:
        ForgotPasswordResponse

      • forgotPasswordSetNewPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_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
        Parameters:
        user - (required)
        Returns:
        ForgotPasswordResponse

      • revokeTokensForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/tokens")
void revokeTokensForUserAndClient​(java.lang.String clientId)
        Revokes all refresh tokens issued for the specified User and Client.
        Parameters:
        clientId - (required)

      • resetFactors

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reset_factors")
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.

      • getLinkedObjects

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/linkedObjects/{relationshipName}")
ResponseLinksList getLinkedObjects​(java.lang.String relationshipName)
        Get linked objects for a user, relationshipName can be a primary or associated relationship name
        Parameters:
        relationshipName - (required)
        Returns:
        ResponseLinksList

      • revokeGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/grants")
void revokeGrants()
        Revokes all grants for a specified user

      • listGroupTargets

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/groups")
GroupList listGroupTargets​(java.lang.String roleId)
        Success
        Parameters:
        roleId - (required)
        Returns:
        GroupList

      • getRefreshTokenForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
OAuth2RefreshToken getRefreshTokenForUserAndClient​(java.lang.String clientId,
                                                   java.lang.String tokenId,
                                                   java.lang.String expand)
        Gets a refresh token issued for the specified User and Client.
        Parameters:
        clientId - (required)
        tokenId - (required)
        expand - (optional)
        Returns:
        OAuth2RefreshToken

      • getRefreshTokenForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
OAuth2RefreshToken getRefreshTokenForUserAndClient​(java.lang.String clientId,
                                                   java.lang.String tokenId)
        Gets a refresh token issued for the specified User and Client.
        Parameters:
        clientId - (required)
        tokenId - (required)
        Returns:
        OAuth2RefreshToken

      • revokeGrantsForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/grants")
void revokeGrantsForUserAndClient​(java.lang.String clientId)
        Revokes all grants for the specified user and client
        Parameters:
        clientId - (required)

      • removeRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}")
void removeRole​(java.lang.String roleId)
        Unassigns a role from a user.
        Parameters:
        roleId - (required)

      • revokeTokenForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
void revokeTokenForUserAndClient​(java.lang.String clientId,
                                 java.lang.String tokenId)
        Revokes the specified refresh token.
        Parameters:
        clientId - (required)
        tokenId - (required)

      • expirePassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/expire_password?tempPassword&#x3D;false")
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.
        Returns:
        User

      • activate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/activate")
UserActivationToken activate​(java.lang.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.
        Parameters:
        sendEmail - Sends an activation email to the user if true (required)
        Returns:
        UserActivationToken

      • changeRecoveryQuestion

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/change_recovery_question")
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
        Parameters:
        userCredentials - (required)
        Returns:
        UserCredentials

      • listGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/grants")
OAuth2ScopeConsentGrantList listGrants​(java.lang.String scopeId,
                                       java.lang.String expand)
        Lists all grants for the specified user
        Parameters:
        scopeId - (optional)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrantList

      • listGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/grants")
OAuth2ScopeConsentGrantList listGrants()
        Lists all grants for the specified user
        Returns:
        OAuth2ScopeConsentGrantList

      • unsuspend

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/unsuspend")
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.

      • assignRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/roles")
Role assignRole​(AssignRoleRequest assignRoleRequest,
                java.lang.Boolean disableNotifications)
        Assigns a role to a user.
        Parameters:
        assignRoleRequest - (required)
        disableNotifications - (optional)
        Returns:
        Role

      • assignRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/roles")
Role assignRole​(AssignRoleRequest assignRoleRequest)
        Assigns a role to a user.
        Parameters:
        assignRoleRequest - (required)
        Returns:
        Role

      • getRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}")
Role getRole​(java.lang.String roleId)
        Gets role that is assigne to user.
        Parameters:
        roleId - (required)
        Returns:
        Role

      • listGroups

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/groups")
GroupList listGroups()
        Get Member Groups Fetches the groups of which the user is a member.
        Returns:
        GroupList

      • listRefreshTokensForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens")
OAuth2RefreshTokenList listRefreshTokensForUserAndClient​(java.lang.String clientId,
                                                         java.lang.String expand)
        Lists all refresh tokens issued for the specified User and Client.
        Parameters:
        clientId - (required)
        expand - (optional)
        Returns:
        OAuth2RefreshTokenList

      • listRefreshTokensForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens")
OAuth2RefreshTokenList listRefreshTokensForUserAndClient​(java.lang.String clientId)
        Lists all refresh tokens issued for the specified User and Client.
        Parameters:
        clientId - (required)
        Returns:
        OAuth2RefreshTokenList

      • removeGroupTarget

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}")
void removeGroupTarget​(java.lang.String roleId,
                       java.lang.String groupId)
        Success
        Parameters:
        roleId - (required)
        groupId - (required)

      • listSupportedFactors

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/factors/catalog")
UserFactorList listSupportedFactors()
        Enumerates all the supported factors that can be enrolled for the specified user
        Returns:
        UserFactorList

      • delete

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}")
void delete​(java.lang.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!**
        Parameters:
        sendEmail - (optional, default to false)

      • delete

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}")
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

      • listClients

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/clients")
OAuth2ClientList listClients()
        Lists all client resources for which the specified user has grants or tokens.
        Returns:
        OAuth2ClientList

      • suspend

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/suspend")
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.

      • revokeGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/grants/{grantId}")
void revokeGrant​(java.lang.String grantId)
        Revokes one grant for a specified user
        Parameters:
        grantId - (required)

      • setLinkedObject

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}")
void setLinkedObject​(java.lang.String primaryRelationshipName,
                     java.lang.String primaryUserId)
        Parameters:
        primaryRelationshipName - (required)
        primaryUserId - (required)

      • removeLinkedObject

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/linkedObjects/{relationshipName}")
void removeLinkedObject​(java.lang.String relationshipName)
        Delete linked objects for a user, relationshipName can be ONLY a primary relationship name
        Parameters:
        relationshipName - (required)

      • unlock

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/unlock")
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.

      • update

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/users/{userId}")
User update​(java.lang.Boolean strict)
        Update User Update a user's profile and/or credentials using strict-update semantics.
        Parameters:
        strict - (optional)
        Returns:
        User

      • update

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/users/{userId}")
User update()
        Update User Update a user's profile and/or credentials using strict-update semantics.
        Returns:
        User

      • deleteFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/users/{userId}/factors/{factorId}")
void deleteFactor​(java.lang.String factorId)
        Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
        Parameters:
        factorId - (required)

      • reactivate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reactivate")
UserActivationToken reactivate​(java.lang.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).
        Parameters:
        sendEmail - Sends an activation email to the user if true (optional, default to false)
        Returns:
        UserActivationToken

      • reactivate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/lifecycle/reactivate")
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).
        Returns:
        UserActivationToken

      • getFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/factors/{factorId}")
UserFactor getFactor​(java.lang.String factorId)
        Fetches a factor for the specified user
        Parameters:
        factorId - (required)
        Returns:
        UserFactor

      • changePassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/change_password")
UserCredentials changePassword​(ChangePasswordRequest changePasswordRequest,
                               java.lang.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
        Parameters:
        changePasswordRequest - (required)
        strict - (optional)
        Returns:
        UserCredentials

      • changePassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/credentials/change_password")
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
        Parameters:
        changePasswordRequest - (required)
        Returns:
        UserCredentials

      • listAppLinks

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/appLinks")
AppLinkList listAppLinks()
        Get Assigned App Links Fetches appLinks for all direct or indirect (via group membership) assigned applications.
        Returns:
        AppLinkList

      • addGroupTarget

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}")
void addGroupTarget​(java.lang.String roleId,
                    java.lang.String groupId)
        Success
        Parameters:
        roleId - (required)
        groupId - (required)

      • listSupportedSecurityQuestions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/factors/questions")
SecurityQuestionList listSupportedSecurityQuestions()
        Enumerates all available security questions for a user's `question` factor
        Returns:
        SecurityQuestionList

      • addToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/groups/{groupId}/users/{userId}")
void addToGroup​(java.lang.String groupId)
        Add User to Group Adds a user to a group with 'OKTA_GROUP' type.
        Parameters:
        groupId - (required)

      • listAssignedRoles

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/roles")
RoleList listAssignedRoles​(java.lang.String expand)
        Lists all roles assigned to a user.
        Parameters:
        expand - (optional)
        Returns:
        RoleList

      • listAssignedRoles

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/roles")
RoleList listAssignedRoles()
        Lists all roles assigned to a user.
        Returns:
        RoleList