All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.akeyless.api.uam.UamApi Maven / Gradle / Ivy

There is a newer version: 0.0.10
Show newest version
package com.akeyless.api.uam;

import com.akeyless.api.exceptions.*;
import com.akeyless.api.utils.AkeylessItemType;
import com.akeyless.uam.swagger.ApiException;
import com.akeyless.uam.swagger.ApiResponse;
import com.akeyless.uam.swagger.model.*;

import java.util.List;

public interface UamApi {

    /**
     *
     * Get UAM server status
     * @return UAMStatusReplyObj
     * @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
     */
    UAMStatusReplyObj getStatus() throws ApiCommunicationException;

    /**
     * Get account details.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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(String akeylessUAMUserCreds) throws ApiCommunicationException,
            CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;

    /**
     * Get an temporary access credentials to KFM instances for item's fragments derivation.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemName The item name for derivation (required)
     * @param itemVersion The item version. If it is empty, the derivation credentials will be returned for the latest item version (optional)
     * @param restrictedDerivationData In case not empty, the derivation credentials will be restricted only to this derivation data (optional)
     * @param credsExpiry The requested expiration time of the temporary credentials in minutes. (optional, default to 60)
     * @return DerivationCredsReplyObj
     * @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 access permissions were found for the item.
     */
    DerivationCredsReplyObj getItemDerivationCreds(String akeylessUAMUserCreds,
                                                   String itemName,
                                                   Integer itemVersion,
                                                   String restrictedDerivationData,
                                                   Long credsExpiry
    ) throws ApiCommunicationException, InvalidParamException, MissingRequiredParamException,
            NotFoundException, CredentialsNotFoundException, InvalidCredentialsException;


    /**
     * Get temporary access credentials to KFM instances for RSA key fragments decryption.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemName The item name for decrypt operation (required)
     * @param itemVersion The item version. If it is empty, the RSA decrypt credentials will be returned for the latest item version (optional)
     * @param restrictedCipher In case not empty, the RSA decrypt credentials will be restricted only to this cipher (optional)
     * @param credsExpiry The requested expiration time of the temporary credentials in minutes. (optional, default to 60)
     * @return RSADecryptCredsReplyObj
     * @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 access permissions were found for the item.
     * */
    RSADecryptCredsReplyObj getRSAKeyDecryptCreds(String akeylessUAMUserCreds,
                                                         String itemName,
                                                         Integer itemVersion,
                                                         String restrictedCipher,
                                                         Long credsExpiry
    ) throws ApiCommunicationException, InvalidParamException, MissingRequiredParamException,
            NotFoundException, CredentialsNotFoundException, InvalidCredentialsException;


    /**
     * Get temporary access credentials to upload RSA private key fragments into KFMs instances.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemName The RSA key name. (required)
     * @param itemType The RSA key type Types available are: [KEY_RSA1024, KEY_RSA2048] (required)
     * @param publicValue The value of the RSA public key . (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)
     * @param credsExpiry The requested expiration time of the temporary credentials in minutes. (optional, default to 60)
     * @return UploadRSAKeyCredsReplyObj
     * @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 an item with the same name already exist in the account.
     * */
    UploadRSAKeyCredsReplyObj getUploadRSAKeyCreds(String akeylessUAMUserCreds,
                                                   String itemName,
                                                   String itemType,
                                                   String publicValue,
                                                   Long splitLevel,
                                                   String userMetadata,
                                                   Long credsExpiry
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException, UnauthorizedUserException;

    /**
     * Get temporary access credentials to KFM instances to produce the derived protected key of the secret.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param secretName The secret name. (required)
     * @param protectedKeyName The name of the key that will be used to encrypt the secret. If not provided, the account default secret key will be used. (optional)
     * @param credsExpiry The requested expiration time of the temporary credentials in minutes. (optional, default to 60)
     * @return DerivationCredsReplyObj
     * @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 an item with the same name already exist in the account.
     * @throws NotFoundException If the protected key name not found or no access permissions were found for it.
     * */
    DerivationCredsReplyObj getUploadSecretCreds(String akeylessUAMUserCreds,
                                                 String secretName,
                                                 String protectedKeyName,
                                                 Long credsExpiry
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException,
            UnauthorizedUserException, NotFoundException;

    /**
     * Get temporary access credentials to KFM instances for secret protected key derivation and the encrypted secret value.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemName The secret item name (required)
     * @param itemVersion The secret item version. If it is empty, the credentials will be returned for the latest secret item version (optional)
     * @param credsExpiry The requested expiration time of the temporary credentials in minutes. (optional, default to 60)
     * @return SecretAccessCredsReplyObj
     * @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.
     * */
    SecretAccessCredsReplyObj getSecretAccessCreds(String akeylessUAMUserCreds,
                                                   String itemName,
                                                   Integer itemVersion,
                                                   Long credsExpiry
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, UnauthorizedUserException;


    /**
     * Add a new item to the account.
     * This endpoint is accessible only by the account admin user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemName The item name to be created (required)
     * @param itemType The type of the item to be created Types available are: [AES128GCM, AES256GCM, AES128SIV, AES256SIV] (required)
     * @param userMetadata User metadata about the item. (required)
     * @param splitLevel The splitting level represent the number of fragments that the item will be split into. (required)
     * @param size The length of the item to be created. (optional)
     * @param uploadRsaKeyCreds The credentials to upload an RSA key. this parameter relevant only in case of item of RSA Key. in this case all the item's creation parameters should be correlated with the parameters in the UploadRSAKeyCreds. (optional)
     * @param uploadSecretCreds The credentials to upload a secret. this parameter relevant only in case of create a new secret. this parameter will be used to extract the protected key and the derivation data that used to encrypt the secret. (optional)
     * @param secretEncVal The encrypted secret value. this parameter relevant only in case of create a new secret. This parameter should contain the encrypted secret that is encrypted using the protected 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 an item with the same name already exist in the account.
     */
    void createItem(String akeylessUAMUserCreds,
                    String itemName,
                    String itemType,
                    String userMetadata,
                    Long splitLevel,
                    Long size,
                    String uploadRsaKeyCreds,
                    String uploadSecretCreds,
                    String secretEncVal
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException, UnauthorizedUserException;

    /**
     * Get item details.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemName Item name. (required)
     * @param itemVersion The item version (for item attributes that are unique to each version). If it is empty, the item attributes of the latest version will be returned (optional)
     * @return GetItemReplyObj
     * @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 item not found or no access permissions were found for the item.
     */
    GetItemReplyObj getItem(String akeylessUAMUserCreds, String itemName, Integer itemVersion) throws ApiCommunicationException,
            MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
            InvalidCredentialsException, NotFoundException;

    /**
     * Get All the items associated with the user.
     *
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param itemTypes The item types list of the requested items . In case it is empty, all types of items will be returned. The format of the item types list is a comma-separated list of a valid item types. Valid opinions are - \"AES128GCM,AES256GCM,AES128SIV,AES256SIV,RSA1024,RSA2048,USER_SECRET\" (optional)
     * @return GetUserItemsReplyObj
     * @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 item is found that the user has access to.
     */
    GetUserItemsReplyObj getUserItems(String akeylessUAMUserCreds,
                                      List itemTypes) throws ApiCommunicationException,
            MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
            InvalidCredentialsException, NotFoundException;

    /**
     * Updating an existing item in the account
     * This endpoint is accessible only by the account admin user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param newItemName The new item name that will replace the existing one (required)
     * @param itemName Item name. (required)
     * @param userMetadata User metadata about the item. (optional)
     * @param itemVersion The item version to be updated. this parameter relevant only when updating a version-dependent attribute of the item (for example a secret encrypted value in case of secret item).  If it is empty, the item attributes of the latest version will be updated. (optional)
     * @param uploadSecretCreds The credentials to upload a secret. this parameter relevant only when updating a secret. this parameter will be used to extract the protected key and the derivation data that used to encrypt the secret. (optional)
     * @param secretEncVal The encrypted secret value. this parameter relevant only when updating a secret. This parameter should contain the encrypted secret that is encrypted using the protected 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 an item with the same name already exist in the account.
     */
    void updateItem(String akeylessUAMUserCreds,
                    String newItemName,
                    String itemName,
                    String userMetadata,
                    Integer itemVersion,
                    String uploadSecretCreds,
                    String secretEncVal
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException;


    /**
     * Deleting an existing item from the account.
     * This endpoint is accessible only by the account admin user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (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 item not found or no access permissions were found for the item.
     */
    void deleteItem(String akeylessUAMUserCreds, String itemName) throws ApiCommunicationException,
            MissingRequiredParamException, InvalidParamException, CredentialsNotFoundException,
            InvalidCredentialsException, NotFoundException;


    /**
     * Add a new user to the account.
     * This endpoint is accessible only by the account admin user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param akeylessSetUserAccessPolicyCreds Temporary credentials for accessing the endpoint (required)
     * @param userName The user name to be created (required)
     * @return CreateUserReplyObj
     * @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.
     */
    CreateUserReplyObj createUser(String akeylessUAMUserCreds,
                                  String akeylessSetUserAccessPolicyCreds,
                                  String userName
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, AlreadyExistsException;


    /**
     * Get user details.
     * This endpoint is accessible only by the account admin user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds, 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
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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(String akeylessUAMUserCreds) 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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param akeylessSetUserAccessPolicyCreds Temporary credentials for accessing the endpoint (required)
     * @param newUserName The new username that will replace the existing one (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 AlreadyExistsException If a user with the same name already exist in the account.
     * @throws NotFoundException If the user not found.
     */
    void updateUser(String akeylessUAMUserCreds,
                           String akeylessSetUserAccessPolicyCreds,
                           String newUserName,
                           String userName
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, NotFoundException, AlreadyExistsException;


    /**
     * Deleting an existing user from the account.
     * This endpoint is accessible only by the account admin user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (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 user not found.
     */
    void deleteUser(String akeylessUAMUserCreds, 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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds,
                    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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds, 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
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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(String akeylessUAMUserCreds) 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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @param newRoleName The new role name that will replace the existing one (required)
     * @param roleName Role name. (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 akeylessUAMUserCreds,
                    String newRoleName,
                    String roleName,
                    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 user
     * @param akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds, 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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds,
                             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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds,
                             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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds,
                             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 akeylessUAMUserCreds Temporary credentials for accessing the endpoint (required)
     * @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 akeylessUAMUserCreds,
                             String roleName,
                             String userName
    ) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
            CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy