com.fortanix.sdkms.v1.api

Class UsersApi

java.lang.Object

com.fortanix.sdkms.v1.api.UsersApi

public class UsersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	changePassword(PasswordChangeRequest body) Change user password
ConfirmEmailResponse	confirmEmail(String userId, ConfirmEmailRequest body) Confirms user's email address
User	createUser(SignupRequest body) Create a new user Signs up a new user.
void	deleteUser(String userId) Removed user's association with an account
void	deleteUserAccount() Completely delete a user profile from system Completely deletes the currently logged in user from the system.
void	forgotPassword(ForgotPasswordRequest body) Initiate password reset sequence for a user
ApiClient	getApiClient()
User	getUser(String userId) Get a specific user
UserAccountMap	getUserAccount() Get account information for the user Obtain the current user's account information.
List<User>	getUsers(String groupId) Get all users
List<User>	getUsers(String groupId, String sort, String start, Integer limit, Integer offset) Get all users
User	inviteUser(UserRequest body) Invite a user Invite an existing user or new user to join an existing account.
void	processInvitations(ProcessInviteRequest body) Process a user's pending account invitations Process a user's pending invitations.
void	resendConfirmEmail(String userId) Resend email with link to confirm user's email address
void	resendInvitation(String userId) Resend invite to the user to join a specific account
void	resetPassword(String userId, PasswordResetRequest body) Reset a user's password Resetting a user's password.
void	setApiClient(ApiClient apiClient)
User	updateUser(String userId, UserRequest body) Update user Change a user's properties.
ValidateTokenResponse	validatePasswordResetToken(String userId, ValidateTokenRequest body) Validates password reset token for the user

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

changePassword

public void changePassword(PasswordChangeRequest body)
                    throws ApiException

Change user password

Parameters:

body - Password change request (required)

Throws:

ApiException - if fails to make API call

confirmEmail

public ConfirmEmailResponse confirmEmail(String userId,
                                         ConfirmEmailRequest body)
                                  throws ApiException

Confirms user's email address

Parameters:

userId - User Identifier (required)

body - Validate user's email (required)

Returns:

ConfirmEmailResponse

Throws:

ApiException - if fails to make API call

createUser

public User createUser(SignupRequest body)
                throws ApiException

Create a new user Signs up a new user.

Parameters:

body - Email address of user (required)

Returns:

User

Throws:

ApiException - if fails to make API call

deleteUser

public void deleteUser(String userId)
                throws ApiException

Removed user's association with an account

Parameters:

userId - User Identifier (required)

Throws:

ApiException - if fails to make API call

deleteUserAccount

public void deleteUserAccount()
                       throws ApiException

Completely delete a user profile from system Completely deletes the currently logged in user from the system.

Throws:

ApiException - if fails to make API call

forgotPassword

public void forgotPassword(ForgotPasswordRequest body)
                    throws ApiException

Initiate password reset sequence for a user

Parameters:

body - Initiate forgot password sequrence (required)

Throws:

ApiException - if fails to make API call

getUser

public User getUser(String userId)
             throws ApiException

Get a specific user

Parameters:

userId - User Identifier (required)

Returns:

User

Throws:

ApiException - if fails to make API call

getUserAccount

public UserAccountMap getUserAccount()
                              throws ApiException

Get account information for the user Obtain the current user's account information.

Returns:

UserAccountMap

Throws:

ApiException - if fails to make API call

getUsers

public List<User> getUsers(String groupId,
                           String sort,
                           String start,
                           Integer limit,
                           Integer offset)
                    throws ApiException

Get all users

Parameters:

groupId - Only retrieve users in the specified group. (optional)

sort - This specifies the property (`user_id` only, for now) and order (ascending or descending) with which to sort the users. By default, users are sorted by `user_id` in ascending order. The syntax is \"<property>:[asc|desc]\" (e.g. \"user_id:desc\") or just \"<property>\" (ascending order by default). (optional)

start - If provided, this must be a value of the property specified in `sort`. Returned users will begin just above or just below this value (for asc/desc order resp.). (optional)

limit - Maximum number of users to return. If not provided, the limit is 100. (optional)

offset - Number of users past `start` to skip. (optional)

Returns:

List<User>

Throws:

ApiException - if fails to make API call

getUsers

public List<User> getUsers(String groupId)
                    throws ApiException

Get all users

Parameters:

groupId - Only retrieve users in the specified group. (optional)

Returns:

List<User>

Throws:

ApiException - if fails to make API call

inviteUser

public User inviteUser(UserRequest body)
                throws ApiException

Invite a user Invite an existing user or new user to join an existing account. Only user email is required for invite API

Parameters:

body - Name of user (required)

Returns:

User

Throws:

ApiException - if fails to make API call

processInvitations

public void processInvitations(ProcessInviteRequest body)
                        throws ApiException

Process a user's pending account invitations Process a user's pending invitations. It does both accepts and rejects.

Parameters:

body - Process account invitation (both accepts and rejects) (required)

Throws:

ApiException - if fails to make API call

resendConfirmEmail

public void resendConfirmEmail(String userId)
                        throws ApiException

Resend email with link to confirm user's email address

Parameters:

userId - User Identifier (required)

Throws:

ApiException - if fails to make API call

resendInvitation

public void resendInvitation(String userId)
                      throws ApiException

Resend invite to the user to join a specific account

Parameters:

userId - User Identifier (required)

Throws:

ApiException - if fails to make API call

resetPassword

public void resetPassword(String userId,
                          PasswordResetRequest body)
                   throws ApiException

Reset a user's password Resetting a user's password. User must have a valid reset token from forgot password step.

Parameters:

userId - User Identifier (required)

body - Reset password (required)

Throws:

ApiException - if fails to make API call

updateUser

public User updateUser(String userId,
                       UserRequest body)
                throws ApiException

Update user Change a user's properties.

Parameters:

userId - User Identifier (required)

body - Name of user (required)

Returns:

User

Throws:

ApiException - if fails to make API call

validatePasswordResetToken

public ValidateTokenResponse validatePasswordResetToken(String userId,
                                                        ValidateTokenRequest body)
                                                 throws ApiException

Validates password reset token for the user

Parameters:

userId - User Identifier (required)

body - Validate token (required)

Returns:

ValidateTokenResponse

Throws:

ApiException - if fails to make API call