ai.whylabs.service.api

Class ApiKeyApi

java.lang.Object

ai.whylabs.service.api.ApiKeyApi

public class ApiKeyApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ApiKeyApi()
ApiKeyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserApiKey	createApiKey(java.lang.String orgId, java.lang.String userId, java.lang.Long expirationTime, java.util.List<java.lang.String> scopes, java.lang.String alias) Generate an API key for a user.
okhttp3.Call	createApiKeyAsync(java.lang.String orgId, java.lang.String userId, java.lang.Long expirationTime, java.util.List<java.lang.String> scopes, java.lang.String alias, ApiCallback<UserApiKey> _callback) Generate an API key for a user.
okhttp3.Call	createApiKeyCall(java.lang.String orgId, java.lang.String userId, java.lang.Long expirationTime, java.util.List<java.lang.String> scopes, java.lang.String alias, ApiCallback _callback) Build call for createApiKey
ApiResponse<UserApiKey>	createApiKeyWithHttpInfo(java.lang.String orgId, java.lang.String userId, java.lang.Long expirationTime, java.util.List<java.lang.String> scopes, java.lang.String alias) Generate an API key for a user.
ApiClient	getApiClient()
ListUserApiKeys	listApiKeys(java.lang.String orgId, java.lang.String userId) List API key metadata for a given organization and user Returns the API key metadata for a given organization and user
okhttp3.Call	listApiKeysAsync(java.lang.String orgId, java.lang.String userId, ApiCallback<ListUserApiKeys> _callback) List API key metadata for a given organization and user (asynchronously) Returns the API key metadata for a given organization and user
okhttp3.Call	listApiKeysCall(java.lang.String orgId, java.lang.String userId, ApiCallback _callback) Build call for listApiKeys
ApiResponse<ListUserApiKeys>	listApiKeysWithHttpInfo(java.lang.String orgId, java.lang.String userId) List API key metadata for a given organization and user Returns the API key metadata for a given organization and user
UserApiKey	revokeApiKey(java.lang.String orgId, java.lang.String userId, java.lang.String keyId) Revoke the given API Key, removing its ability to access WhyLabs systems Revokes the given API Key
okhttp3.Call	revokeApiKeyAsync(java.lang.String orgId, java.lang.String userId, java.lang.String keyId, ApiCallback<UserApiKey> _callback) Revoke the given API Key, removing its ability to access WhyLabs systems (asynchronously) Revokes the given API Key
okhttp3.Call	revokeApiKeyCall(java.lang.String orgId, java.lang.String userId, java.lang.String keyId, ApiCallback _callback) Build call for revokeApiKey
ApiResponse<UserApiKey>	revokeApiKeyWithHttpInfo(java.lang.String orgId, java.lang.String userId, java.lang.String keyId) Revoke the given API Key, removing its ability to access WhyLabs systems Revokes the given API Key
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKeyApi

public ApiKeyApi()

ApiKeyApi

public ApiKeyApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createApiKeyCall

public okhttp3.Call createApiKeyCall(java.lang.String orgId,
                                     java.lang.String userId,
                                     java.lang.Long expirationTime,
                                     java.util.List<java.lang.String> scopes,
                                     java.lang.String alias,
                                     ApiCallback _callback)
                              throws ApiException

Build call for createApiKey

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. (required)

expirationTime - Expiration time in epoch milliseconds (optional)

scopes - Scopes of the token (optional)

alias - A human-friendly name for the API Key An object with key ID and other metadata about the key (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A object with key ID and other metadata about the key	-

createApiKey

public UserApiKey createApiKey(java.lang.String orgId,
                               java.lang.String userId,
                               java.lang.Long expirationTime,
                               java.util.List<java.lang.String> scopes,
                               java.lang.String alias)
                        throws ApiException

Generate an API key for a user. Generates an API key for a given user. Must be called either by system administrator or by the user themselves

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. (required)

expirationTime - Expiration time in epoch milliseconds (optional)

scopes - Scopes of the token (optional)

alias - A human-friendly name for the API Key An object with key ID and other metadata about the key (optional)

Returns:

UserApiKey

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A object with key ID and other metadata about the key	-

createApiKeyWithHttpInfo

public ApiResponse<UserApiKey> createApiKeyWithHttpInfo(java.lang.String orgId,
                                                        java.lang.String userId,
                                                        java.lang.Long expirationTime,
                                                        java.util.List<java.lang.String> scopes,
                                                        java.lang.String alias)
                                                 throws ApiException

Generate an API key for a user. Generates an API key for a given user. Must be called either by system administrator or by the user themselves

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. (required)

expirationTime - Expiration time in epoch milliseconds (optional)

scopes - Scopes of the token (optional)

alias - A human-friendly name for the API Key An object with key ID and other metadata about the key (optional)

Returns:

ApiResponse<UserApiKey>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A object with key ID and other metadata about the key	-

createApiKeyAsync

public okhttp3.Call createApiKeyAsync(java.lang.String orgId,
                                      java.lang.String userId,
                                      java.lang.Long expirationTime,
                                      java.util.List<java.lang.String> scopes,
                                      java.lang.String alias,
                                      ApiCallback<UserApiKey> _callback)
                               throws ApiException

Generate an API key for a user. (asynchronously) Generates an API key for a given user. Must be called either by system administrator or by the user themselves

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. (required)

expirationTime - Expiration time in epoch milliseconds (optional)

scopes - Scopes of the token (optional)

alias - A human-friendly name for the API Key An object with key ID and other metadata about the key (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A object with key ID and other metadata about the key	-

listApiKeysCall

public okhttp3.Call listApiKeysCall(java.lang.String orgId,
                                    java.lang.String userId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for listApiKeys

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. A list of objects with key ID and other metadata about the keys, but no secret values (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A list of objects with key ID and other metadata about the keys, but no secret values	-

listApiKeys

public ListUserApiKeys listApiKeys(java.lang.String orgId,
                                   java.lang.String userId)
                            throws ApiException

List API key metadata for a given organization and user Returns the API key metadata for a given organization and user

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. A list of objects with key ID and other metadata about the keys, but no secret values (required)

Returns:

ListUserApiKeys

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A list of objects with key ID and other metadata about the keys, but no secret values	-

listApiKeysWithHttpInfo

public ApiResponse<ListUserApiKeys> listApiKeysWithHttpInfo(java.lang.String orgId,
                                                            java.lang.String userId)
                                                     throws ApiException

List API key metadata for a given organization and user Returns the API key metadata for a given organization and user

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. A list of objects with key ID and other metadata about the keys, but no secret values (required)

Returns:

ApiResponse<ListUserApiKeys>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A list of objects with key ID and other metadata about the keys, but no secret values	-

listApiKeysAsync

public okhttp3.Call listApiKeysAsync(java.lang.String orgId,
                                     java.lang.String userId,
                                     ApiCallback<ListUserApiKeys> _callback)
                              throws ApiException

List API key metadata for a given organization and user (asynchronously) Returns the API key metadata for a given organization and user

Parameters:

orgId - Your company's unique organization ID (required)

userId - The unique user ID in an organization. A list of objects with key ID and other metadata about the keys, but no secret values (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A list of objects with key ID and other metadata about the keys, but no secret values	-

revokeApiKeyCall

public okhttp3.Call revokeApiKeyCall(java.lang.String orgId,
                                     java.lang.String userId,
                                     java.lang.String keyId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for revokeApiKey

Parameters:

orgId - (required)

userId - (required)

keyId - ID of the key to revoke Metadata for the revoked API Key (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	Revoked API Key's metadata	-

revokeApiKey

public UserApiKey revokeApiKey(java.lang.String orgId,
                               java.lang.String userId,
                               java.lang.String keyId)
                        throws ApiException

Revoke the given API Key, removing its ability to access WhyLabs systems Revokes the given API Key

Parameters:

orgId - (required)

userId - (required)

keyId - ID of the key to revoke Metadata for the revoked API Key (required)

Returns:

UserApiKey

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	Revoked API Key's metadata	-

revokeApiKeyWithHttpInfo

public ApiResponse<UserApiKey> revokeApiKeyWithHttpInfo(java.lang.String orgId,
                                                        java.lang.String userId,
                                                        java.lang.String keyId)
                                                 throws ApiException

Revoke the given API Key, removing its ability to access WhyLabs systems Revokes the given API Key

Parameters:

orgId - (required)

userId - (required)

keyId - ID of the key to revoke Metadata for the revoked API Key (required)

Returns:

ApiResponse<UserApiKey>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	Revoked API Key's metadata	-

revokeApiKeyAsync

public okhttp3.Call revokeApiKeyAsync(java.lang.String orgId,
                                      java.lang.String userId,
                                      java.lang.String keyId,
                                      ApiCallback<UserApiKey> _callback)
                               throws ApiException

Revoke the given API Key, removing its ability to access WhyLabs systems (asynchronously) Revokes the given API Key

Parameters:

orgId - (required)

userId - (required)

keyId - ID of the key to revoke Metadata for the revoked API Key (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	Revoked API Key's metadata	-