org.openapitools.client.api

Class ApiTokenApi

java.lang.Object

org.openapitools.client.api.ApiTokenApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class ApiTokenApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiTokenApi()
ApiTokenApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ApiToken	getApiToken(String apiTokenId) Retrieve an API Token's Metadata Retrieves the metadata for an active API token by id
ApiToken	getApiToken(String apiTokenId, Map<String,String> additionalHeaders) Retrieve an API Token's Metadata Retrieves the metadata for an active API token by id
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<ApiToken>	listApiTokens(String after, Integer limit, String q) List all API Token Metadata Lists all the metadata of the active API tokens
List<ApiToken>	listApiTokens(String after, Integer limit, String q, Map<String,String> additionalHeaders) List all API Token Metadata Lists all the metadata of the active API tokens
void	revokeApiToken(String apiTokenId) Revoke an API Token Revokes an API token by `apiTokenId`
void	revokeApiToken(String apiTokenId, Map<String,String> additionalHeaders) Revoke an API Token Revokes an API token by `apiTokenId`
void	revokeCurrentApiToken() Revoke the Current API Token Revokes the API token provided in the Authorization header
void	revokeCurrentApiToken(Map<String,String> additionalHeaders) Revoke the Current API Token Revokes the API token provided in the Authorization header
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiTokenApi

public ApiTokenApi()

ApiTokenApi

public ApiTokenApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getApiToken

public ApiToken getApiToken(String apiTokenId)
                     throws ApiException

Retrieve an API Token's Metadata Retrieves the metadata for an active API token by id

Parameters:

apiTokenId - id of the API Token (required)

Returns:

ApiToken

Throws:

ApiException - if fails to make API call

getApiToken

public ApiToken getApiToken(String apiTokenId,
                            Map<String,String> additionalHeaders)
                     throws ApiException

Retrieve an API Token's Metadata Retrieves the metadata for an active API token by id

Parameters:

apiTokenId - id of the API Token (required)

additionalHeaders - additionalHeaders for this call

Returns:

ApiToken

Throws:

ApiException - if fails to make API call

listApiTokens

public List<ApiToken> listApiTokens(String after,
                                    Integer limit,
                                    String q)
                             throws ApiException

List all API Token Metadata Lists all the metadata of the active API tokens

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

limit - A limit on the number of objects to return (optional, default to 20)

q - Finds a token that matches the name or clientName. (optional)

Returns:

List<ApiToken>

Throws:

ApiException - if fails to make API call

listApiTokens

public List<ApiToken> listApiTokens(String after,
                                    Integer limit,
                                    String q,
                                    Map<String,String> additionalHeaders)
                             throws ApiException

List all API Token Metadata Lists all the metadata of the active API tokens

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

limit - A limit on the number of objects to return (optional, default to 20)

q - Finds a token that matches the name or clientName. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<ApiToken>

Throws:

ApiException - if fails to make API call

revokeApiToken

public void revokeApiToken(String apiTokenId)
                    throws ApiException

Revoke an API Token Revokes an API token by `apiTokenId`

Parameters:

apiTokenId - id of the API Token (required)

Throws:

ApiException - if fails to make API call

revokeApiToken

public void revokeApiToken(String apiTokenId,
                           Map<String,String> additionalHeaders)
                    throws ApiException

Revoke an API Token Revokes an API token by `apiTokenId`

Parameters:

apiTokenId - id of the API Token (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

revokeCurrentApiToken

public void revokeCurrentApiToken()
                           throws ApiException

Revoke the Current API Token Revokes the API token provided in the Authorization header

Throws:

ApiException - if fails to make API call

revokeCurrentApiToken

public void revokeCurrentApiToken(Map<String,String> additionalHeaders)
                           throws ApiException

Revoke the Current API Token Revokes the API token provided in the Authorization header

Parameters:

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()