com.fortanix.sdkms.v1.api

Class AccountsApi

java.lang.Object

com.fortanix.sdkms.v1.api.AccountsApi

public class AccountsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AccountsApi()
AccountsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Account	createAccount(AccountRequest body) Create a new account Create a new account with the specified properties.
void	deleteAccount(String accountId) Delete account Remove an account from SDKMS.
Account	getAccount(String accountId) Get a specific account Look up an account by account ID.
List<Account>	getAccounts() Get all accounts Get detailed information on all accounts the current user has access to.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
Account	updateAccount(String accountId, AccountRequest body) Update account Update the properties of an account.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountsApi

public AccountsApi()

AccountsApi

public AccountsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAccount

public Account createAccount(AccountRequest body)
                      throws ApiException

Create a new account Create a new account with the specified properties.

Parameters:

body - Properties to assign to Account. (required)

Returns:

Account

Throws:

ApiException - if fails to make API call

deleteAccount

public void deleteAccount(String accountId)
                   throws ApiException

Delete account Remove an account from SDKMS.

Parameters:

accountId - Account Identifier (required)

Throws:

ApiException - if fails to make API call

getAccount

public Account getAccount(String accountId)
                   throws ApiException

Get a specific account Look up an account by account ID.

Parameters:

accountId - Account Identifier (required)

Returns:

Account

Throws:

ApiException - if fails to make API call

getAccounts

public List<Account> getAccounts()
                          throws ApiException

Get all accounts Get detailed information on all accounts the current user has access to.

Returns:

List<Account>

Throws:

ApiException - if fails to make API call

updateAccount

public Account updateAccount(String accountId,
                             AccountRequest body)
                      throws ApiException

Update account Update the properties of an account. Only certain properties may be changed with this API.

Parameters:

accountId - Account Identifier (required)

body - Properties to assign to Account. (required)

Returns:

Account

Throws:

ApiException - if fails to make API call