org.openapitools.client.api

Class UserApi

java.lang.Object

org.openapitools.client.api.UserApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.UserApi")
public class UserApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserApi()
UserApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserActivationToken	activateUser(String userId, Boolean sendEmail) Activate a User Activates a user.
PagedList	activateUserWithPaginationInfo(String userId, Boolean sendEmail) Activate a User Activates a user.
<T> T	changePassword(Class<?> T, String userId, ChangePasswordRequest changePasswordRequest, Boolean strict) Change Password Changes a user's password by validating the user's current password.
UserCredentials	changePassword(String userId, ChangePasswordRequest changePasswordRequest, Boolean strict) Change Password Changes a user's password by validating the user's current password.
PagedList	changePasswordWithPaginationInfo(String userId, ChangePasswordRequest changePasswordRequest, Boolean strict) Change Password Changes a user's password by validating the user's current password.
<T> T	changeRecoveryQuestion(Class<?> T, String userId, UserCredentials userCredentials) Change Recovery Question Changes a user's recovery question & answer credential by validating the user's current password.
UserCredentials	changeRecoveryQuestion(String userId, UserCredentials userCredentials) Change Recovery Question Changes a user's recovery question & answer credential by validating the user's current password.
PagedList	changeRecoveryQuestionWithPaginationInfo(String userId, UserCredentials userCredentials) Change Recovery Question Changes a user's recovery question & answer credential by validating the user's current password.
<T> T	createUser(Class<?> T, CreateUserRequest body, Boolean activate, Boolean provider, UserNextLogin nextLogin) Create a User Creates a new user in your Okta organization with or without credentials
User	createUser(CreateUserRequest body, Boolean activate, Boolean provider, UserNextLogin nextLogin) Create a User Creates a new user in your Okta organization with or without credentials
PagedList	createUserWithPaginationInfo(CreateUserRequest body, Boolean activate, Boolean provider, UserNextLogin nextLogin) Create a User Creates a new user in your Okta organization with or without credentials
void	deactivateUser(String userId, Boolean sendEmail) Deactivate a User Deactivates a user.
void	deleteLinkedObjectForUser(String userId, String relationshipName) Delete a Linked Object Deletes linked objects for a user, relationshipName can be ONLY a primary relationship name
void	deleteUser(String userId, Boolean sendEmail) Delete a User Deletes a user permanently.
User	expirePassword(String userId) 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(String userId) Expire Password and Set Temporary 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, and also sets the user's password to a temporary password returned in the response
PagedList	expirePasswordAndGetTemporaryPasswordWithPaginationInfo(String userId) Expire Password and Set Temporary 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, and also sets the user's password to a temporary password returned in the response
PagedList	expirePasswordWithPaginationInfo(String userId) 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(String userId, Boolean sendEmail) Initiate Forgot Password Initiate forgot password flow.
<T> T	forgotPasswordSetNewPassword(Class<?> T, String userId, UserCredentials userCredentials, Boolean sendEmail) Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct
UserCredentials	forgotPasswordSetNewPassword(String userId, UserCredentials userCredentials, Boolean sendEmail) Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct
PagedList	forgotPasswordSetNewPasswordWithPaginationInfo(String userId, UserCredentials userCredentials, Boolean sendEmail) Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct
PagedList	forgotPasswordWithPaginationInfo(String userId, Boolean sendEmail) Initiate Forgot Password Initiate forgot password flow.
ApiClient	getApiClient()
OAuth2RefreshToken	getRefreshTokenForUserAndClient(String userId, String clientId, String tokenId, String expand, Integer limit, String after) Retrieve a Refresh Token for a Client Retrieves a refresh token issued for the specified User and Client
PagedList	getRefreshTokenForUserAndClientWithPaginationInfo(String userId, String clientId, String tokenId, String expand, Integer limit, String after) Retrieve a Refresh Token for a Client Retrieves a refresh token issued for the specified User and Client
User	getUser(String userId) Retrieve a User Retrieves a user from your Okta organization
OAuth2ScopeConsentGrant	getUserGrant(String userId, String grantId, String expand) Retrieve a User Grant Retrieves a grant for the specified user
PagedList	getUserGrantWithPaginationInfo(String userId, String grantId, String expand) Retrieve a User Grant Retrieves a grant for the specified user
PagedList	getUserWithPaginationInfo(String userId) Retrieve a User Retrieves a user from your Okta organization
List<AppLink>	listAppLinks(String userId) List all Assigned Application Links Lists all appLinks for all direct or indirect (via group membership) assigned applications
PagedList	listAppLinksWithPaginationInfo(String userId) List all Assigned Application Links Lists all appLinks for all direct or indirect (via group membership) assigned applications
List<OAuth2ScopeConsentGrant>	listGrantsForUserAndClient(String userId, String clientId, String expand, String after, Integer limit) List all Grants for a Client Lists all grants for a specified user and client
PagedList	listGrantsForUserAndClientWithPaginationInfo(String userId, String clientId, String expand, String after, Integer limit) List all Grants for a Client Lists all grants for a specified user and client
List<Object>	listLinkedObjectsForUser(String userId, String relationshipName, String after, Integer limit) List all Linked Objects Lists all linked objects for a user, relationshipName can be a primary or associated relationship name
PagedList	listLinkedObjectsForUserWithPaginationInfo(String userId, String relationshipName, String after, Integer limit) List all Linked Objects Lists all linked objects for a user, relationshipName can be a primary or associated relationship name
List<OAuth2RefreshToken>	listRefreshTokensForUserAndClient(String userId, String clientId, String expand, String after, Integer limit) List all Refresh Tokens for a Client Lists all refresh tokens issued for the specified User and Client
PagedList	listRefreshTokensForUserAndClientWithPaginationInfo(String userId, String clientId, String expand, String after, Integer limit) List all Refresh Tokens for a Client Lists all refresh tokens issued for the specified User and Client
List<OAuth2Client>	listUserClients(String userId) List all Clients Lists all client resources for which the specified user has grants or tokens
PagedList	listUserClientsWithPaginationInfo(String userId) List all Clients Lists all client resources for which the specified user has grants or tokens
List<OAuth2ScopeConsentGrant>	listUserGrants(String userId, String scopeId, String expand, String after, Integer limit) List all User Grants Lists all grants for the specified user
PagedList	listUserGrantsWithPaginationInfo(String userId, String scopeId, String expand, String after, Integer limit) List all User Grants Lists all grants for the specified user
List<Group>	listUserGroups(String userId) List all Groups Lists all groups of which the user is a member
PagedList	listUserGroupsWithPaginationInfo(String userId) List all Groups Lists all groups of which the user is a member
List<IdentityProvider>	listUserIdentityProviders(String userId) List all Identity Providers Lists the IdPs associated with the user
PagedList	listUserIdentityProvidersWithPaginationInfo(String userId) List all Identity Providers Lists the IdPs associated with the user
List<User>	listUsers(String q, String after, Integer limit, String filter, String search, String sortBy, String sortOrder) List all Users List all users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination.
PagedList	listUsersWithPaginationInfo(String q, String after, Integer limit, String filter, String search, String sortBy, String sortOrder) List all Users List all users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination.
UserActivationToken	reactivateUser(String userId, Boolean sendEmail) Reactivate a User Reactivates a user.
PagedList	reactivateUserWithPaginationInfo(String userId, Boolean sendEmail) Reactivate a User Reactivates a user.
<T> T	replaceUser(Class<?> T, String userId, UpdateUserRequest user, Boolean strict) Replace a User Replaces a user's profile and/or credentials using strict-update semantics
User	replaceUser(String userId, UpdateUserRequest user, Boolean strict) Replace a User Replaces a user's profile and/or credentials using strict-update semantics
PagedList	replaceUserWithPaginationInfo(String userId, UpdateUserRequest user, Boolean strict) Replace a User Replaces a user's profile and/or credentials using strict-update semantics
void	resetFactors(String userId) Reset all Factors This operation resets all factors for the specified user.
ResetPasswordToken	resetPassword(String userId, Boolean sendEmail) Reset Password Generates a one-time token (OTT) that can be used to reset a user's password.
PagedList	resetPasswordWithPaginationInfo(String userId, Boolean sendEmail) Reset Password Generates a one-time token (OTT) that can be used to reset a user's password.
void	revokeGrantsForUserAndClient(String userId, String clientId) Revoke all Grants for a Client Revokes all grants for the specified user and client
void	revokeTokenForUserAndClient(String userId, String clientId, String tokenId) Revoke a Token for a Client Revokes the specified refresh token
void	revokeTokensForUserAndClient(String userId, String clientId) Revoke all Refresh Tokens for a Client Revokes all refresh tokens issued for the specified User and Client
void	revokeUserGrant(String userId, String grantId) Revoke a User Grant Revokes one grant for a specified user
void	revokeUserGrants(String userId) Revoke all User Grants Revokes all grants for a specified user
void	revokeUserSessions(String userId, Boolean oauthTokens) Revoke all User Sessions Revokes all active identity provider sessions of the user.
void	setApiClient(ApiClient apiClient)
void	setLinkedObjectForUser(String associatedUserId, String primaryRelationshipName, String primaryUserId) Create a Linked Object for two User Creates a linked object for two users
void	suspendUser(String userId) Suspend a User Suspends a user.
void	unlockUser(String userId) Unlock a User Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status.
void	unsuspendUser(String userId) Unsuspend a User Unsuspends a user and returns them to the `ACTIVE` state.
<T> T	updateUser(Class<?> T, String userId, UpdateUserRequest user, Boolean strict) Update a User Updates a user partially determined by the request parameters
User	updateUser(String userId, UpdateUserRequest user, Boolean strict) Update a User Updates a user partially determined by the request parameters
PagedList	updateUserWithPaginationInfo(String userId, UpdateUserRequest user, Boolean strict) Update a User Updates a user partially determined by the request parameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserApi

public UserApi()

UserApi

@Autowired
public UserApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateUser

public UserActivationToken activateUser(String userId,
                                        Boolean sendEmail)
                                 throws org.springframework.web.client.RestClientException

Activate a 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.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

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

Returns:

UserActivationToken

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateUserWithPaginationInfo

public PagedList activateUserWithPaginationInfo(String userId,
                                                Boolean sendEmail)
                                         throws org.springframework.web.client.RestClientException

Activate a 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.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

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

Returns:

ResponseEntity<UserActivationToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

changePassword

public UserCredentials changePassword(String userId,
                                      ChangePasswordRequest changePasswordRequest,
                                      Boolean strict)
                               throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

changePasswordRequest - (required)

strict - (optional)

Returns:

UserCredentials

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

changePassword

public <T> T changePassword(Class<?> T,
                            String userId,
                            ChangePasswordRequest changePasswordRequest,
                            Boolean strict)
                     throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

changePasswordRequest - (required)

strict - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

changePasswordWithPaginationInfo

public PagedList changePasswordWithPaginationInfo(String userId,
                                                  ChangePasswordRequest changePasswordRequest,
                                                  Boolean strict)
                                           throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

changePasswordRequest - (required)

strict - (optional)

Returns:

ResponseEntity<UserCredentials>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

changeRecoveryQuestion

public UserCredentials changeRecoveryQuestion(String userId,
                                              UserCredentials userCredentials)
                                       throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

userCredentials - (required)

Returns:

UserCredentials

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

changeRecoveryQuestion

public <T> T changeRecoveryQuestion(Class<?> T,
                                    String userId,
                                    UserCredentials userCredentials)
                             throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

userCredentials - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

changeRecoveryQuestionWithPaginationInfo

public PagedList changeRecoveryQuestionWithPaginationInfo(String userId,
                                                          UserCredentials userCredentials)
                                                   throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

userCredentials - (required)

Returns:

ResponseEntity<UserCredentials>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createUser

public User createUser(CreateUserRequest body,
                       Boolean activate,
                       Boolean provider,
                       UserNextLogin nextLogin)
                throws org.springframework.web.client.RestClientException

Create a User Creates a new user in your Okta organization with or without credentials

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

body - (required)

activate - Executes activation lifecycle operation when creating the user (optional, default to true)

provider - Indicates whether to create a user with a specified authentication provider (optional, default to false)

nextLogin - With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in. (optional)

Returns:

User

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createUser

public <T> T createUser(Class<?> T,
                        CreateUserRequest body,
                        Boolean activate,
                        Boolean provider,
                        UserNextLogin nextLogin)
                 throws org.springframework.web.client.RestClientException

Create a User Creates a new user in your Okta organization with or without credentials

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

body - (required)

activate - Executes activation lifecycle operation when creating the user (optional, default to true)

provider - Indicates whether to create a user with a specified authentication provider (optional, default to false)

nextLogin - With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in. (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createUserWithPaginationInfo

public PagedList createUserWithPaginationInfo(CreateUserRequest body,
                                              Boolean activate,
                                              Boolean provider,
                                              UserNextLogin nextLogin)
                                       throws org.springframework.web.client.RestClientException

Create a User Creates a new user in your Okta organization with or without credentials

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

body - (required)

activate - Executes activation lifecycle operation when creating the user (optional, default to true)

provider - Indicates whether to create a user with a specified authentication provider (optional, default to false)

nextLogin - With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in. (optional)

Returns:

ResponseEntity<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateUser

public void deactivateUser(String userId,
                           Boolean sendEmail)
                    throws org.springframework.web.client.RestClientException

Deactivate a 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.

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

sendEmail - (optional, default to false)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteLinkedObjectForUser

public void deleteLinkedObjectForUser(String userId,
                                      String relationshipName)
                               throws org.springframework.web.client.RestClientException

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

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

relationshipName - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteUser

public void deleteUser(String userId,
                       Boolean sendEmail)
                throws org.springframework.web.client.RestClientException

Delete a User Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**. Calling this on an `ACTIVE` user will transition the user to `DEPROVISIONED`.

204 - No Content

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

sendEmail - (optional, default to false)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

expirePassword

public User expirePassword(String userId)
                    throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

User

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

expirePasswordWithPaginationInfo

public PagedList expirePasswordWithPaginationInfo(String userId)
                                           throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

expirePasswordAndGetTemporaryPassword

public TempPassword expirePasswordAndGetTemporaryPassword(String userId)
                                                   throws org.springframework.web.client.RestClientException

Expire Password and Set Temporary 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, and also sets the user's password to a temporary password returned in the response

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

TempPassword

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

expirePasswordAndGetTemporaryPasswordWithPaginationInfo

public PagedList expirePasswordAndGetTemporaryPasswordWithPaginationInfo(String userId)
                                                                  throws org.springframework.web.client.RestClientException

Expire Password and Set Temporary 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, and also sets the user's password to a temporary password returned in the response

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<TempPassword>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

forgotPassword

public ForgotPasswordResponse forgotPassword(String userId,
                                             Boolean sendEmail)
                                      throws org.springframework.web.client.RestClientException

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

200 - Reset url

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

sendEmail - (optional, default to true)

Returns:

ForgotPasswordResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

forgotPasswordWithPaginationInfo

public PagedList forgotPasswordWithPaginationInfo(String userId,
                                                  Boolean sendEmail)
                                           throws org.springframework.web.client.RestClientException

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

200 - Reset url

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

sendEmail - (optional, default to true)

Returns:

ResponseEntity<ForgotPasswordResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

forgotPasswordSetNewPassword

public UserCredentials forgotPasswordSetNewPassword(String userId,
                                                    UserCredentials userCredentials,
                                                    Boolean sendEmail)
                                             throws org.springframework.web.client.RestClientException

Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct

200 - Credentials

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

userCredentials - (required)

sendEmail - (optional, default to true)

Returns:

UserCredentials

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

forgotPasswordSetNewPassword

public <T> T forgotPasswordSetNewPassword(Class<?> T,
                                          String userId,
                                          UserCredentials userCredentials,
                                          Boolean sendEmail)
                                   throws org.springframework.web.client.RestClientException

Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct

200 - Credentials

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

userCredentials - (required)

sendEmail - (optional, default to true)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

forgotPasswordSetNewPasswordWithPaginationInfo

public PagedList forgotPasswordSetNewPasswordWithPaginationInfo(String userId,
                                                                UserCredentials userCredentials,
                                                                Boolean sendEmail)
                                                         throws org.springframework.web.client.RestClientException

Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct

200 - Credentials

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

userCredentials - (required)

sendEmail - (optional, default to true)

Returns:

ResponseEntity<UserCredentials>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRefreshTokenForUserAndClient

public OAuth2RefreshToken getRefreshTokenForUserAndClient(String userId,
                                                          String clientId,
                                                          String tokenId,
                                                          String expand,
                                                          Integer limit,
                                                          String after)
                                                   throws org.springframework.web.client.RestClientException

Retrieve a Refresh Token for a Client Retrieves a refresh token issued for the specified User and Client

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

tokenId - (required)

expand - (optional)

limit - (optional, default to 20)

after - (optional)

Returns:

OAuth2RefreshToken

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRefreshTokenForUserAndClientWithPaginationInfo

public PagedList getRefreshTokenForUserAndClientWithPaginationInfo(String userId,
                                                                   String clientId,
                                                                   String tokenId,
                                                                   String expand,
                                                                   Integer limit,
                                                                   String after)
                                                            throws org.springframework.web.client.RestClientException

Retrieve a Refresh Token for a Client Retrieves a refresh token issued for the specified User and Client

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

tokenId - (required)

expand - (optional)

limit - (optional, default to 20)

after - (optional)

Returns:

ResponseEntity<OAuth2RefreshToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUser

public User getUser(String userId)
             throws org.springframework.web.client.RestClientException

Retrieve a User Retrieves a user from your Okta organization

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

User

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserWithPaginationInfo

public PagedList getUserWithPaginationInfo(String userId)
                                    throws org.springframework.web.client.RestClientException

Retrieve a User Retrieves a user from your Okta organization

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserGrant

public OAuth2ScopeConsentGrant getUserGrant(String userId,
                                            String grantId,
                                            String expand)
                                     throws org.springframework.web.client.RestClientException

Retrieve a User Grant Retrieves a grant for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

grantId - (required)

expand - (optional)

Returns:

OAuth2ScopeConsentGrant

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserGrantWithPaginationInfo

public PagedList getUserGrantWithPaginationInfo(String userId,
                                                String grantId,
                                                String expand)
                                         throws org.springframework.web.client.RestClientException

Retrieve a User Grant Retrieves a grant for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

grantId - (required)

expand - (optional)

Returns:

ResponseEntity<OAuth2ScopeConsentGrant>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAppLinks

public List<AppLink> listAppLinks(String userId)
                           throws org.springframework.web.client.RestClientException

List all Assigned Application Links Lists all appLinks for all direct or indirect (via group membership) assigned applications

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<AppLink>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAppLinksWithPaginationInfo

public PagedList listAppLinksWithPaginationInfo(String userId)
                                         throws org.springframework.web.client.RestClientException

List all Assigned Application Links Lists all appLinks for all direct or indirect (via group membership) assigned applications

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<AppLink>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGrantsForUserAndClient

public List<OAuth2ScopeConsentGrant> listGrantsForUserAndClient(String userId,
                                                                String clientId,
                                                                String expand,
                                                                String after,
                                                                Integer limit)
                                                         throws org.springframework.web.client.RestClientException

List all Grants for a Client Lists all grants for a specified user and client

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

expand - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

List<OAuth2ScopeConsentGrant>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGrantsForUserAndClientWithPaginationInfo

public PagedList listGrantsForUserAndClientWithPaginationInfo(String userId,
                                                              String clientId,
                                                              String expand,
                                                              String after,
                                                              Integer limit)
                                                       throws org.springframework.web.client.RestClientException

List all Grants for a Client Lists all grants for a specified user and client

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

expand - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<OAuth2ScopeConsentGrant>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLinkedObjectsForUser

public List<Object> listLinkedObjectsForUser(String userId,
                                             String relationshipName,
                                             String after,
                                             Integer limit)
                                      throws org.springframework.web.client.RestClientException

List all Linked Objects Lists all linked objects for a user, relationshipName can be a primary or associated relationship name

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

relationshipName - (required)

after - (optional)

limit - (optional, default to -1)

Returns:

List<Object>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLinkedObjectsForUserWithPaginationInfo

public PagedList listLinkedObjectsForUserWithPaginationInfo(String userId,
                                                            String relationshipName,
                                                            String after,
                                                            Integer limit)
                                                     throws org.springframework.web.client.RestClientException

List all Linked Objects Lists all linked objects for a user, relationshipName can be a primary or associated relationship name

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

relationshipName - (required)

after - (optional)

limit - (optional, default to -1)

Returns:

ResponseEntity<List<Object>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRefreshTokensForUserAndClient

public List<OAuth2RefreshToken> listRefreshTokensForUserAndClient(String userId,
                                                                  String clientId,
                                                                  String expand,
                                                                  String after,
                                                                  Integer limit)
                                                           throws org.springframework.web.client.RestClientException

List all Refresh Tokens for a Client Lists all refresh tokens issued for the specified User and Client

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

expand - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

List<OAuth2RefreshToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listRefreshTokensForUserAndClientWithPaginationInfo

public PagedList listRefreshTokensForUserAndClientWithPaginationInfo(String userId,
                                                                     String clientId,
                                                                     String expand,
                                                                     String after,
                                                                     Integer limit)
                                                              throws org.springframework.web.client.RestClientException

List all Refresh Tokens for a Client Lists all refresh tokens issued for the specified User and Client

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

expand - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<OAuth2RefreshToken>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserClients

public List<OAuth2Client> listUserClients(String userId)
                                   throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<OAuth2Client>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserClientsWithPaginationInfo

public PagedList listUserClientsWithPaginationInfo(String userId)
                                            throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<OAuth2Client>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserGrants

public List<OAuth2ScopeConsentGrant> listUserGrants(String userId,
                                                    String scopeId,
                                                    String expand,
                                                    String after,
                                                    Integer limit)
                                             throws org.springframework.web.client.RestClientException

List all User Grants Lists all grants for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

scopeId - (optional)

expand - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

List<OAuth2ScopeConsentGrant>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserGrantsWithPaginationInfo

public PagedList listUserGrantsWithPaginationInfo(String userId,
                                                  String scopeId,
                                                  String expand,
                                                  String after,
                                                  Integer limit)
                                           throws org.springframework.web.client.RestClientException

List all User Grants Lists all grants for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

scopeId - (optional)

expand - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<OAuth2ScopeConsentGrant>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserGroups

public List<Group> listUserGroups(String userId)
                           throws org.springframework.web.client.RestClientException

List all Groups Lists all groups of which the user is a member

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserGroupsWithPaginationInfo

public PagedList listUserGroupsWithPaginationInfo(String userId)
                                           throws org.springframework.web.client.RestClientException

List all Groups Lists all groups of which the user is a member

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<Group>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserIdentityProviders

public List<IdentityProvider> listUserIdentityProviders(String userId)
                                                 throws org.springframework.web.client.RestClientException

List all Identity Providers Lists the IdPs associated with the user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUserIdentityProvidersWithPaginationInfo

public PagedList listUserIdentityProvidersWithPaginationInfo(String userId)
                                                      throws org.springframework.web.client.RestClientException

List all Identity Providers Lists the IdPs associated with the user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<IdentityProvider>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUsers

public List<User> listUsers(String q,
                            String after,
                            Integer limit,
                            String filter,
                            String search,
                            String sortBy,
                            String sortOrder)
                     throws org.springframework.web.client.RestClientException

List all Users List all users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination. A subset of users can be returned that match a supported filter expression or search criteria.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

q - Finds a user that matches firstName, lastName, and email properties (optional)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

limit - Specifies the number of results returned. Defaults to 10 if `q` is provided. (optional, default to 200)

filter - Filters users with a supported expression for a subset of properties (optional)

search - Searches for users with a supported filtering expression for most properties. Okta recommends using this parameter for search for best performance. (optional)

sortBy - (optional)

sortOrder - (optional)

Returns:

List<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listUsersWithPaginationInfo

public PagedList listUsersWithPaginationInfo(String q,
                                             String after,
                                             Integer limit,
                                             String filter,
                                             String search,
                                             String sortBy,
                                             String sortOrder)
                                      throws org.springframework.web.client.RestClientException

List all Users List all users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination. A subset of users can be returned that match a supported filter expression or search criteria.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

q - Finds a user that matches firstName, lastName, and email properties (optional)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

limit - Specifies the number of results returned. Defaults to 10 if `q` is provided. (optional, default to 200)

filter - Filters users with a supported expression for a subset of properties (optional)

search - Searches for users with a supported filtering expression for most properties. Okta recommends using this parameter for search for best performance. (optional)

sortBy - (optional)

sortOrder - (optional)

Returns:

ResponseEntity<List<User>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

reactivateUser

public UserActivationToken reactivateUser(String userId,
                                          Boolean sendEmail)
                                   throws org.springframework.web.client.RestClientException

Reactivate a 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).

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

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

Returns:

UserActivationToken

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

reactivateUserWithPaginationInfo

public PagedList reactivateUserWithPaginationInfo(String userId,
                                                  Boolean sendEmail)
                                           throws org.springframework.web.client.RestClientException

Reactivate a 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).

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

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

Returns:

ResponseEntity<UserActivationToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceUser

public User replaceUser(String userId,
                        UpdateUserRequest user,
                        Boolean strict)
                 throws org.springframework.web.client.RestClientException

Replace a User Replaces a user's profile and/or credentials using strict-update semantics

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

user - (required)

strict - (optional)

Returns:

User

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceUser

public <T> T replaceUser(Class<?> T,
                         String userId,
                         UpdateUserRequest user,
                         Boolean strict)
                  throws org.springframework.web.client.RestClientException

Replace a User Replaces a user's profile and/or credentials using strict-update semantics

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

user - (required)

strict - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceUserWithPaginationInfo

public PagedList replaceUserWithPaginationInfo(String userId,
                                               UpdateUserRequest user,
                                               Boolean strict)
                                        throws org.springframework.web.client.RestClientException

Replace a User Replaces a user's profile and/or credentials using strict-update semantics

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

user - (required)

strict - (optional)

Returns:

ResponseEntity<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

resetFactors

public void resetFactors(String userId)
                  throws org.springframework.web.client.RestClientException

Reset all 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.

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

resetPassword

public ResetPasswordToken resetPassword(String userId,
                                        Boolean sendEmail)
                                 throws org.springframework.web.client.RestClientException

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.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

sendEmail - (required)

Returns:

ResetPasswordToken

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

resetPasswordWithPaginationInfo

public PagedList resetPasswordWithPaginationInfo(String userId,
                                                 Boolean sendEmail)
                                          throws org.springframework.web.client.RestClientException

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.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

sendEmail - (required)

Returns:

ResponseEntity<ResetPasswordToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeGrantsForUserAndClient

public void revokeGrantsForUserAndClient(String userId,
                                         String clientId)
                                  throws org.springframework.web.client.RestClientException

Revoke all Grants for a Client Revokes all grants for the specified user and client

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeTokenForUserAndClient

public void revokeTokenForUserAndClient(String userId,
                                        String clientId,
                                        String tokenId)
                                 throws org.springframework.web.client.RestClientException

Revoke a Token for a Client Revokes the specified refresh token

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

tokenId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeTokensForUserAndClient

public void revokeTokensForUserAndClient(String userId,
                                         String clientId)
                                  throws org.springframework.web.client.RestClientException

Revoke all Refresh Tokens for a Client Revokes all refresh tokens issued for the specified User and Client

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

clientId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeUserGrant

public void revokeUserGrant(String userId,
                            String grantId)
                     throws org.springframework.web.client.RestClientException

Revoke a User Grant Revokes one grant for a specified user

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

grantId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeUserGrants

public void revokeUserGrants(String userId)
                      throws org.springframework.web.client.RestClientException

Revoke all User Grants Revokes all grants for a specified user

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeUserSessions

public void revokeUserSessions(String userId,
                               Boolean oauthTokens)
                        throws org.springframework.web.client.RestClientException

Revoke all User Sessions Revokes all active identity provider sessions of the user. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

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

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

setLinkedObjectForUser

public void setLinkedObjectForUser(String associatedUserId,
                                   String primaryRelationshipName,
                                   String primaryUserId)
                            throws org.springframework.web.client.RestClientException

Create a Linked Object for two User Creates a linked object for two users

204 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

associatedUserId - (required)

primaryRelationshipName - (required)

primaryUserId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

suspendUser

public void suspendUser(String userId)
                 throws org.springframework.web.client.RestClientException

Suspend a 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.

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unlockUser

public void unlockUser(String userId)
                throws org.springframework.web.client.RestClientException

Unlock a 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.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unsuspendUser

public void unsuspendUser(String userId)
                   throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateUser

public User updateUser(String userId,
                       UpdateUserRequest user,
                       Boolean strict)
                throws org.springframework.web.client.RestClientException

Update a User Updates a user partially determined by the request parameters

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

user - (required)

strict - (optional)

Returns:

User

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateUser

public <T> T updateUser(Class<?> T,
                        String userId,
                        UpdateUserRequest user,
                        Boolean strict)
                 throws org.springframework.web.client.RestClientException

Update a User Updates a user partially determined by the request parameters

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

user - (required)

strict - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateUserWithPaginationInfo

public PagedList updateUserWithPaginationInfo(String userId,
                                              UpdateUserRequest user,
                                              Boolean strict)
                                       throws org.springframework.web.client.RestClientException

Update a User Updates a user partially determined by the request parameters

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

user - (required)

strict - (optional)

Returns:

ResponseEntity<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API