com.fortanix.sdkms.v1.api

Class AppsApi

java.lang.Object

com.fortanix.sdkms.v1.api.AppsApi

public class AppsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AppsApi()
AppsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
App	createApp(AppRequest body) Create a new application Create a new application with the specified properties.
void	deleteApp(String appId) Delete application Remove an application from SDKMS.
ApiClient	getApiClient()
App	getApp(String appId) Get a specific application Look up an application by application ID.
List<App>	getApps(String groupId) Get all applications Get details of all applications the current user has access to.
List<App>	getApps(String groupId, String sort, String start, Integer limit, Integer offset) Get all applications Get details of all applications the current user has access to.
AppCredentialResponse	getCredential(String appId) Get a specific application's credential Retrieve the authentication credential (API key or certificate) for a particular application.
App	regenerateApiKey(String appId, AppResetSecretRequest body) Regenerate API key Create a new API key for an application.
void	setApiClient(ApiClient apiClient)
App	updateApp(String appId, AppRequest body) Update an application Change an application's properties, such as name, description, or group membership.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppsApi

public AppsApi()

AppsApi

public AppsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createApp

public App createApp(AppRequest body)
              throws ApiException

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

Parameters:

body - Properties of application to create (required)

Returns:

App

Throws:

ApiException - if fails to make API call

deleteApp

public void deleteApp(String appId)
               throws ApiException

Delete application Remove an application from SDKMS.

Parameters:

appId - Application Identifier (required)

Throws:

ApiException - if fails to make API call

getApp

public App getApp(String appId)
           throws ApiException

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

Parameters:

appId - Application Identifier (required)

Returns:

App

Throws:

ApiException - if fails to make API call

getApps

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

Get all applications Get details of all applications the current user has access to.

Parameters:

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

sort - This specifies the property (`app_id` only, for now) and order (ascending or descending) with which to sort the apps. By default, apps are sorted by `app_id` in ascending order. The syntax is \"<property>:[asc|desc]\" (e.g. \"app_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 apps will begin just above or just below this value (for asc/desc order resp.). (optional)

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

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

Returns:

List<App>

Throws:

ApiException - if fails to make API call

getApps

public List<App> getApps(String groupId)
                  throws ApiException

Get all applications Get details of all applications the current user has access to.

Parameters:

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

Returns:

List<App>

Throws:

ApiException - if fails to make API call

getCredential

public AppCredentialResponse getCredential(String appId)
                                    throws ApiException

Get a specific application's credential Retrieve the authentication credential (API key or certificate) for a particular application. Only users who are an administrator of at least one of the application's groups can retrieve the credential.

Parameters:

appId - Application Identifier (required)

Returns:

AppCredentialResponse

Throws:

ApiException - if fails to make API call

regenerateApiKey

public App regenerateApiKey(String appId,
                            AppResetSecretRequest body)
                     throws ApiException

Regenerate API key Create a new API key for an application. An application may only have one valid API key at a time, so performing this action will invalidate all old API keys. This does not invalidate existing sessions, so any applications with an existing open session will be able to continue operating with their old session until those sessions expire.

Parameters:

appId - Application Identifier (required)

body - Decryption request (required)

Returns:

App

Throws:

ApiException - if fails to make API call

updateApp

public App updateApp(String appId,
                     AppRequest body)
              throws ApiException

Update an application Change an application's properties, such as name, description, or group membership.

Parameters:

appId - Application Identifier (required)

body - Properties of application to create (required)

Returns:

App

Throws:

ApiException - if fails to make API call