com.fortanix.sdkms.v1.api

Class AuthenticationApi

java.lang.Object

com.fortanix.sdkms.v1.api.AuthenticationApi

public class AuthenticationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AuthenticationApi()
AuthenticationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AuthResponse	authorize() Create a session for a user or an app Authenticate a user or an app to SDKMS to begin a session.
void	checkHealth() Check whether the server is handling requests Returns a 200-class status code if the server is handling requests, or a 500-class status code if the server is having problems.
ApiClient	getApiClient()
VersionResponse	getServerVersion() Get SDKMS version information Returns information about the SDKMS server version and the client API version that it supports.
AuthResponse	reAuth() Create a new session for a user or an app using an existing session bearer token.
void	refresh() Refreshes existing user or app session.
SelectAccountResponse	selectAccount(SelectAccountRequest body) Select a user's account to work on Select one of user's account to proceed.
void	setApiClient(ApiClient apiClient)
void	terminate() Terminate a session Terminate an authenticated session.
void	unlock2F() Unlock two factor configuration Re-authenticate to unlock two factor configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationApi

public AuthenticationApi()

AuthenticationApi

public AuthenticationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

authorize

public AuthResponse authorize()
                       throws ApiException

Create a session for a user or an app Authenticate a user or an app to SDKMS to begin a session. The caller needs to provide a basic authentication token to authenticate to SDKMS. The response body contains a bearer authentication token which needs to be provided by subsequent calls for the duration of the session.

Returns:

AuthResponse

Throws:

ApiException - if fails to make API call

checkHealth

public void checkHealth()
                 throws ApiException

Check whether the server is handling requests Returns a 200-class status code if the server is handling requests, or a 500-class status code if the server is having problems.

Throws:

ApiException - if fails to make API call

getServerVersion

public VersionResponse getServerVersion()
                                 throws ApiException

Get SDKMS version information Returns information about the SDKMS server version and the client API version that it supports.

Returns:

VersionResponse

Throws:

ApiException - if fails to make API call

reAuth

public AuthResponse reAuth()
                    throws ApiException

Create a new session for a user or an app using an existing session bearer token. Authenticate a user or an app to SDKMS using existing session token, to generate a new session. The caller needs to provide bearer authentication token of an existing valid session. The response body contains a bearer authentication token of the new session created.

Returns:

AuthResponse

Throws:

ApiException - if fails to make API call

refresh

public void refresh()
             throws ApiException

Refreshes existing user or app session. Refreshes an existing session, thus extending the expiration time of the existing bearer authentication token. The caller needs to provide bearer token of sesssion need to be refreshed. The response body is empty.

Throws:

ApiException - if fails to make API call

selectAccount

public SelectAccountResponse selectAccount(SelectAccountRequest body)
                                    throws ApiException

Select a user's account to work on Select one of user's account to proceed. This is applicable when a user is associated with more than one account. The caller needs to provide a bearer token for the session in the request body.

Parameters:

body - Select Account Request (required)

Returns:

SelectAccountResponse

Throws:

ApiException - if fails to make API call

terminate

public void terminate()
               throws ApiException

Terminate a session Terminate an authenticated session. After this call, the provided bearer authentication token will be invalidated and cannot be used to make any further API calls.

Throws:

ApiException - if fails to make API call

unlock2F

public void unlock2F()
              throws ApiException

Unlock two factor configuration Re-authenticate to unlock two factor configuration. Two factor configuration must be unlocked to enable or disable two factor authentication, add or remove two factor devices, or regenerate recovery codes. The caller needs to provide a bearer token for the session in the request body.

Throws:

ApiException - if fails to make API call