Package com.mypurecloud.sdk.v2.api

Class TokensApi

java.lang.Object

com.mypurecloud.sdk.v2.api.TokensApi

public class TokensApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TokensApi()
TokensApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteToken(DeleteTokenRequest request)	Delete all auth tokens for the specified user.
ApiResponse<Void>	deleteToken(ApiRequest<Void> request)	Delete all auth tokens for the specified user.
void	deleteToken(String userId)	Delete all auth tokens for the specified user.
void	deleteTokensMe()	Delete auth token used to make the request.
void	deleteTokensMe(DeleteTokensMeRequest request)	Delete auth token used to make the request.
ApiResponse<Void>	deleteTokensMe(ApiRequest<Void> request)	Delete auth token used to make the request.
ApiResponse<Void>	deleteTokensMeWithHttpInfo()	Delete auth token used to make the request.
ApiResponse<Void>	deleteTokenWithHttpInfo(String userId)	Delete all auth tokens for the specified user.
TokenInfo	getTokensMe(GetTokensMeRequest request)	Fetch information about the current token
ApiResponse<TokenInfo>	getTokensMe(ApiRequest<Void> request)	Fetch information about the current token
TokenInfo	getTokensMe(Boolean preserveIdleTTL)	Fetch information about the current token
ApiResponse<TokenInfo>	getTokensMeWithHttpInfo(Boolean preserveIdleTTL)	Fetch information about the current token
IdleTokenTimeout	getTokensTimeout()	Get the current Idle Token Timeout Value
IdleTokenTimeout	getTokensTimeout(GetTokensTimeoutRequest request)	Get the current Idle Token Timeout Value
ApiResponse<IdleTokenTimeout>	getTokensTimeout(ApiRequest<Void> request)	Get the current Idle Token Timeout Value
ApiResponse<IdleTokenTimeout>	getTokensTimeoutWithHttpInfo()	Get the current Idle Token Timeout Value
void	headTokensMe()	Verify user token
void	headTokensMe(HeadTokensMeRequest request)	Verify user token
ApiResponse<Void>	headTokensMe(ApiRequest<Void> request)	Verify user token
ApiResponse<Void>	headTokensMeWithHttpInfo()	Verify user token
IdleTokenTimeout	putTokensTimeout(PutTokensTimeoutRequest request)	Update or Enable/Disable the Idle Token Timeout
ApiResponse<IdleTokenTimeout>	putTokensTimeout(ApiRequest<IdleTokenTimeout> request)	Update or Enable/Disable the Idle Token Timeout
IdleTokenTimeout	putTokensTimeout(IdleTokenTimeout body)	Update or Enable/Disable the Idle Token Timeout
ApiResponse<IdleTokenTimeout>	putTokensTimeoutWithHttpInfo(IdleTokenTimeout body)	Update or Enable/Disable the Idle Token Timeout

Methods inherited from class java.lang.Object

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

Constructor Details

TokensApi

public TokensApi()

TokensApi

public TokensApi(ApiClient apiClient)

Method Details

deleteToken

public void deleteToken(String userId)
                 throws IOException,
ApiException

Delete all auth tokens for the specified user.

Parameters:

userId - User ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTokenWithHttpInfo

public ApiResponse<Void> deleteTokenWithHttpInfo(String userId)
                                          throws IOException

Delete all auth tokens for the specified user.

Parameters:

userId - User ID (required)

Throws:

IOException - if the request fails to be processed

deleteToken

public void deleteToken(DeleteTokenRequest request)
                 throws IOException,
ApiException

Delete all auth tokens for the specified user.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteToken

public ApiResponse<Void> deleteToken(ApiRequest<Void> request)
                              throws IOException

Delete all auth tokens for the specified user.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteTokensMe

public void deleteTokensMe()
                    throws IOException,
ApiException

Delete auth token used to make the request.

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTokensMeWithHttpInfo

public ApiResponse<Void> deleteTokensMeWithHttpInfo()
                                             throws IOException

Delete auth token used to make the request.

Throws:

IOException - if the request fails to be processed

deleteTokensMe

public void deleteTokensMe(DeleteTokensMeRequest request)
                    throws IOException,
ApiException

Delete auth token used to make the request.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTokensMe

public ApiResponse<Void> deleteTokensMe(ApiRequest<Void> request)
                                 throws IOException

Delete auth token used to make the request.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getTokensMe

public TokenInfo getTokensMe(Boolean preserveIdleTTL)
                      throws IOException,
ApiException

Fetch information about the current token

Parameters:

preserveIdleTTL - preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset. (optional)

Returns:

TokenInfo

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTokensMeWithHttpInfo

public ApiResponse<TokenInfo> getTokensMeWithHttpInfo(Boolean preserveIdleTTL)
                                               throws IOException

Fetch information about the current token

Parameters:

preserveIdleTTL - preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset. (optional)

Returns:

TokenInfo

Throws:

IOException - if the request fails to be processed

getTokensMe

public TokenInfo getTokensMe(GetTokensMeRequest request)
                      throws IOException,
ApiException

Fetch information about the current token

Parameters:

request - The request object

Returns:

TokenInfo

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTokensMe

public ApiResponse<TokenInfo> getTokensMe(ApiRequest<Void> request)
                                   throws IOException

Fetch information about the current token

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getTokensTimeout

public IdleTokenTimeout getTokensTimeout()
                                  throws IOException,
ApiException

Get the current Idle Token Timeout Value

Returns:

IdleTokenTimeout

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTokensTimeoutWithHttpInfo

public ApiResponse<IdleTokenTimeout> getTokensTimeoutWithHttpInfo()
                                                           throws IOException

Get the current Idle Token Timeout Value

Returns:

IdleTokenTimeout

Throws:

IOException - if the request fails to be processed

getTokensTimeout

public IdleTokenTimeout getTokensTimeout(GetTokensTimeoutRequest request)
                                  throws IOException,
ApiException

Get the current Idle Token Timeout Value

Parameters:

request - The request object

Returns:

IdleTokenTimeout

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTokensTimeout

public ApiResponse<IdleTokenTimeout> getTokensTimeout(ApiRequest<Void> request)
                                               throws IOException

Get the current Idle Token Timeout Value

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

headTokensMe

public void headTokensMe()
                  throws IOException,
ApiException

Verify user token

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

headTokensMeWithHttpInfo

public ApiResponse<Void> headTokensMeWithHttpInfo()
                                           throws IOException

Verify user token

Throws:

IOException - if the request fails to be processed

headTokensMe

public void headTokensMe(HeadTokensMeRequest request)
                  throws IOException,
ApiException

Verify user token

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

headTokensMe

public ApiResponse<Void> headTokensMe(ApiRequest<Void> request)
                               throws IOException

Verify user token

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putTokensTimeout

public IdleTokenTimeout putTokensTimeout(IdleTokenTimeout body)
                                  throws IOException,
ApiException

Update or Enable/Disable the Idle Token Timeout

Parameters:

body - (optional)

Returns:

IdleTokenTimeout

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putTokensTimeoutWithHttpInfo

public ApiResponse<IdleTokenTimeout> putTokensTimeoutWithHttpInfo(IdleTokenTimeout body)
                                                           throws IOException

Update or Enable/Disable the Idle Token Timeout

Parameters:

body - (optional)

Returns:

IdleTokenTimeout

Throws:

IOException - if the request fails to be processed

putTokensTimeout

public IdleTokenTimeout putTokensTimeout(PutTokensTimeoutRequest request)
                                  throws IOException,
ApiException

Update or Enable/Disable the Idle Token Timeout

Parameters:

request - The request object

Returns:

IdleTokenTimeout

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putTokensTimeout

public ApiResponse<IdleTokenTimeout> putTokensTimeout(ApiRequest<IdleTokenTimeout> request)
                                               throws IOException

Update or Enable/Disable the Idle Token Timeout

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed