org.openapitools.client.api

Class ApiTokenApi

java.lang.Object

org.openapitools.client.api.ApiTokenApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-10T11:07:35.698-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.ApiTokenApi")
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
PagedList	getApiTokenWithPaginationInfo(String apiTokenId) Retrieve an API Token's Metadata Retrieves the metadata for an active API token by id
List<ApiToken>	listApiTokens(String after, Integer limit, String q) List all API Token Metadata Lists all the metadata of the active API tokens
PagedList	listApiTokensWithPaginationInfo(String after, Integer limit, String q) List all API Token Metadata Lists all the metadata of the active API tokens
void	revokeApiToken(String apiTokenId) Revoke an API Token Revoke an API token by id
void	revokeCurrentApiToken() 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

@Autowired
public ApiTokenApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getApiToken

public ApiToken getApiToken(String apiTokenId)
                     throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

apiTokenId - id of the API Token (required)

Returns:

ApiToken

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getApiTokenWithPaginationInfo

public PagedList getApiTokenWithPaginationInfo(String apiTokenId)
                                        throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

apiTokenId - id of the API Token (required)

Returns:

ResponseEntity<ApiToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listApiTokens

public List<ApiToken> listApiTokens(String after,
                                    Integer limit,
                                    String q)
                             throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

429 - Too Many Requests

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:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listApiTokensWithPaginationInfo

public PagedList listApiTokensWithPaginationInfo(String after,
                                                 Integer limit,
                                                 String q)
                                          throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

429 - Too Many Requests

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:

ResponseEntity<List<ApiToken>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeApiToken

public void revokeApiToken(String apiTokenId)
                    throws org.springframework.web.client.RestClientException

Revoke an API Token Revoke an API token by id

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

apiTokenId - id of the API Token (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeCurrentApiToken

public void revokeCurrentApiToken()
                           throws org.springframework.web.client.RestClientException

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

204 - No Content

403 - Forbidden

429 - Too Many Requests

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API