Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.akeyless;
import com.akeyless.api.exceptions.*;
import com.akeyless.config.AkeylessUserConfiguration;
import com.akeyless.config.ConfigUtils;
import com.akeyless.crypto.utils.CryptoAlgorithm;
import com.akeyless.types.ApiKey;
import com.akeyless.types.UserAccessApiKey;
import com.akeyless.uam.swagger.model.*;
import java.io.FileNotFoundException;
import java.io.UnsupportedEncodingException;
import java.nio.file.Path;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.security.PrivateKey;
import java.security.SignatureException;
import java.util.List;
public interface AkeylessAdminUser extends AkeylessUser {
static class Factory {
/**
* Create a new instance of AkeylessUser
*
* @param userConfig The configuration parameters for the AkeylessUser
* @return AkeylessUser
* @throws UnsupportedEncodingException If the API key provided in the configuration parameters is incorrect
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public static AkeylessAdminUser newInstance(AkeylessUserConfiguration userConfig
) throws UnsupportedEncodingException, ApiCommunicationException {
return new AkeylessAdminUserImpl(userConfig);
}
/**
* Create a new instance of AkeylessUser
*
* @param configFilePath The path to a file that contains the configuration parameters for the AkeylessUser
* @return AkeylessUser
* @throws FileNotFoundException If the configuration file is not found.
* @throws UnsupportedEncodingException If the API key provided in the configuration parameters is incorrect
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public static AkeylessAdminUser newInstance(Path configFilePath
) throws UnsupportedEncodingException, ApiCommunicationException, FileNotFoundException {
return new AkeylessAdminUserImpl(ConfigUtils.loadSdkConfigurationFromFile(configFilePath));
}
}
/**
* Get account details.
*
* @return GetAccountDetailsReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials not found.
* @throws InvalidCredentialsException If the user's access credentials are invalid.
* @throws NotFoundException If customer not found.
*/
GetAccountDetailsReplyObj getAccountDetails() throws ApiCommunicationException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
/**
* Creating a new AES key.
* This endpoint is accessible only by the account admin user.
* @param keyName The key name to be created (required)
* @param alg The algorithm for the key to be created. Types available are: [AES128GCM, AES256GCM, AES128SIV, AES256SIV] (required)
* @param splitLevel The splitting level represent the number of fragments that the key will be split into. (required)
* @param userMetadata User metadata about the key. (optional)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws UnauthorizedUserException If the user is not an administrator.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If key with the same name already exist in the account.
*/
void createAESKey(String keyName,
CryptoAlgorithm alg,
int splitLevel,
String userMetadata
) throws ApiCommunicationException, InvalidParamException, MissingRequiredParamException,
CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException, UnauthorizedUserException, NoSuchAlgorithmException;
/**
* Creating a new RSA key.
* This endpoint is accessible only by the account admin user.
* @param keyName The key name to be created (required)
* @param alg The algorithm for the key to be created. Types available are: [RSA1024, RSA2048] (required)
* @param splitLevel The splitting level represent the number of fragments that the key will be split into. (required)
* @param userMetadata User metadata about the key. (optional)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws UnauthorizedUserException If the user is not an administrator.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If key with the same name already exist in the account.
*/
void createRSAKey(String keyName,
CryptoAlgorithm alg,
int splitLevel,
String userMetadata
) throws ApiCommunicationException, InvalidParamException, MissingRequiredParamException,
CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException, UnauthorizedUserException, NoSuchAlgorithmException, SignatureException, InvalidKeyException;
/**
* Updating an existing key.
* This endpoint is accessible only by the account admin user
* @param keyName Key name. (required)
* @param newKeyName The new key name that will replace the existing one (required)
* @param userMetadata User metadata about the key. (optional)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If key with the same name already exist in the account.
*/
void updateKey(String keyName,
String newKeyName,
String userMetadata
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException;
/**
* Deleting an existing key from the account.
* This endpoint is accessible only by the account admin role
* @param keyName Key name. (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials not found.
* @throws InvalidCredentialsException If the user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If key not found or no access permissions were found for the key.
*/
void deleteKey(String keyName) throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Creating a new user.
* This endpoint is accessible only by the account admin user
* @param userName The user name to be created (required)
* @param accessExpires User access expiration date in Unix timestamp. In case of 0 or null the user access will not be limited in time.
* @param cidrWhitelist * An CIDR Whitelisting. Only requests from the ip addresses that match the CIDR list will be able to obtain temporary access credentials. The list length is limited to 10 CIDRs. In the case of an empty string there will be no restriction of IP addresses.
* @return UserAccessApiKey
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If a user with the same name already exist in the account.
*/
UserAccessApiKey createUser(String userName,
Long accessExpires,
List cidrWhitelist
) throws ApiCommunicationException, InvalidParamException, MissingRequiredParamException,
CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException;
/**
* Get user details.
* This endpoint is accessible only by the account admin user
* @param userName User name. (required)
* @return GetUserReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials not found.
* @throws InvalidCredentialsException If the user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the user not found.
*/
GetUserReplyObj getUser(String userName) throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Get All the existing users in the account.
* This endpoint is accessible only by the account admin user
* @return GetAccountUsersReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials not found.
* @throws InvalidCredentialsException If the user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If no user is found in the account.
*/
GetAccountUsersReplyObj getAccountUsers() throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Updating an existing user in the account
* This endpoint is accessible only by the account admin user
* @param userName User name. (required)
* @param newUserName The new username that will replace the existing one (required)
* @param accessExpires User access expiration date in Unix timestamp. In case of 0 or null the user access will not be limited in time.
* @param cidrWhitelist * An CIDR Whitelisting. Only requests from the ip addresses that match the CIDR list will be able to obtain temporary access credentials. The list length is limited to 10 CIDRs. In the case of an empty string there will be no restriction of IP addresses.
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If a user with the same name already exist in the account.
* @throws NotFoundException If the user not found.
*/
void updateUser(String userName,
String newUserName,
Long accessExpires,
List cidrWhitelist
) throws ApiCommunicationException, InvalidParamException, MissingRequiredParamException,
CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException, NotFoundException;
/**
* Replacing the user's access API key.
* This endpoint is accessible only by the account admin user
* @param userName User name. (required)
* @return ApiKey
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If a user with the same name already exist in the account.
* @throws NotFoundException If the user not found.
*/
ApiKey resetUserAccessKey(String userName) throws ApiCommunicationException,
InvalidParamException, MissingRequiredParamException, CredentialsNotFoundException,
InvalidCredentialsException, AlreadyExistsException, NotFoundException;
/**
* Deleting an existing user from the account.
* This endpoint is accessible only by the account admin user
* @param userName User name. (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the user not found or no access permissions were found for the item.
*/
void deleteUser(String userName) throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Add a new role to the account.
* This endpoint is accessible only by the account admin user
* @param roleName The role name to be created (required)
* @param roleAction The role action. (optional)
* @param comment Comments (optional)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If a user with the same name already exist in the account.
*/
void createRole(String roleName,
String roleAction,
String comment
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException;
/**
* Get role details.
* This endpoint is accessible only by the account admin user
* @param roleName Role name. (required)
* @return GetRoleReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials not found.
* @throws InvalidCredentialsException If the user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the role not found.
*/
GetRoleReplyObj getRole(String roleName) throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Get All the existing roles in the account.
* This endpoint is accessible only by the account admin user
* @return GetAccountRolesReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials not found.
* @throws InvalidCredentialsException If the user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If no role is found in the account.
*/
GetAccountRolesReplyObj getAccountRoles() throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Updating an existing role in the account
* This endpoint is accessible only by the account admin user
* @param roleName Role name. (required)
* @param newRoleName The new role name that will replace the existing one (required)
* @param roleAction The role action. (optional)
* @param comment Comments (optional)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws AlreadyExistsException If a user with the same name already exist in the account.
* @throws NotFoundException If the role not found.
*/
void updateRole(String roleName,
String newRoleName,
String roleAction,
String comment
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException, AlreadyExistsException;
/**
* Deleting an existing role from the account.
* This endpoint is accessible only by the account admin role
* @param roleName Role name. (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the role not found.
*/
void deleteRole(String roleName) throws ApiCommunicationException,
MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
InvalidCredentialsException, NotFoundException;
/**
* Create an association between a role and an item.
* This endpoint is accessible only by the account admin user
* @param roleName The role name to be associated (required)
* @param itemName The item name to be associated. (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the role or the item not found.
*/
void createRoleItemAssoc(String roleName,
String itemName
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
/**
* Create an association between a role and an user.
* This endpoint is accessible only by the account admin user
* @param roleName The role name to be associated (required)
* @param userName The user name to be associated. (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the role or the user not found.
*/
void createRoleUserAssoc(String roleName,
String userName
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
/**
* Delete an association between a role and an item.
* This endpoint is accessible only by the account admin user
* @param roleName Role name (required)
* @param itemName Item name (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the role or the item not found.
*/
void deleteRoleItemAssoc(String roleName,
String itemName
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
/**
* Delete an association between a role and an user.
* This endpoint is accessible only by the account admin user
* @param roleName Role name (required)
* @param userName User name (required)
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body.
* @throws CredentialsNotFoundException If the admin user access credentials not found.
* @throws InvalidCredentialsException If the admin user's access credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If the role or the user not found.
*/
void deleteRoleUserAssoc(String roleName,
String userName
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
}
