akeyless 3.1.1 → 3.1.2

data/docs/UpdateDBTarget.md

@@ -25,6 +25,8 @@
 | **port** | **String** |  | [optional] |
 | **pwd** | **String** |  | [optional] |
 | **snowflake_account** | **String** |  | [optional] |
+| **snowflake_api_private_key** | **String** | RSA Private key (base64 encoded) | [optional] |
+| **snowflake_api_private_key_password** | **String** | The Private key passphrase | [optional] |
 | **ssl** | **Boolean** | SSL connection mode | [optional] |
 | **ssl_certificate** | **String** | SSL connection certificate | [optional] |
 | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
@@ -59,6 +61,8 @@ instance = Akeyless::UpdateDBTarget.new(
   port: null,
   pwd: null,
   snowflake_account: null,
+  snowflake_api_private_key: null,
+  snowflake_api_private_key_password: null,
   ssl: null,
   ssl_certificate: null,
   token: null,

data/docs/UpdateItem.md

@@ -8,9 +8,10 @@
 | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
 | **cert_file_data** | **String** | PEM Certificate in a Base64 format. Used for updating RSA keys' certificates. | [optional] |
 | **delete_protection** | **String** |  | [optional] |
+| **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
 | **json** | **Boolean** | Set output format to JSON | [optional] |
 | **name** | **String** | Current item name |  |
-| **new_metadata** | **String** | New item metadata | [optional][default to 'default_metadata'] |
+| **new_metadata** | **String** | Deprecated - use description | [optional][default to 'default_metadata'] |
 | **new_name** | **String** | New item name | [optional] |
 | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
 | **secure_access_add_host** | **Array<String>** |  | [optional] |
@@ -50,6 +51,7 @@ instance = Akeyless::UpdateItem.new(
   add_tag: null,
   cert_file_data: null,
   delete_protection: null,
+  description: null,
   json: null,
   name: null,
   new_metadata: null,

data/docs/UpdatePKICertIssuer.md

@@ -12,10 +12,11 @@
 | **client_flag** | **Boolean** | If set, certificates will be flagged for client auth use | [optional] |
 | **code_signing_flag** | **Boolean** | If set, certificates will be flagged for code signing use | [optional] |
 | **country** | **String** | A comma-separated list of the country that will be set in the issued certificate | [optional] |
+| **description** | **String** | Description of the object | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional] |
 | **key_usage** | **String** | key-usage | [optional][default to 'DigitalSignature,KeyAgreement,KeyEncipherment'] |
 | **locality** | **String** | A comma-separated list of the locality that will be set in the issued certificate | [optional] |
-| **metadata** | **String** | A metadata about the issuer | [optional] |
+| **metadata** | **String** | Deprecated - use description | [optional] |
 | **name** | **String** | PKI certificate issuer name |  |
 | **new_name** | **String** | New item name | [optional] |
 | **not_enforce_hostnames** | **Boolean** | If set, any names are allowed for CN and SANs in the certificate and not only a valid host name | [optional] |
@@ -46,6 +47,7 @@ instance = Akeyless::UpdatePKICertIssuer.new(
   client_flag: null,
   code_signing_flag: null,
   country: null,
+  description: null,
   json: null,
   key_usage: null,
   locality: null,

data/docs/UpdateRotatedSecret.md

@@ -10,12 +10,13 @@
 | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation | [optional] |
 | **aws_region** | **String** | Region (used in aws) | [optional][default to 'us-east-2'] |
 | **custom_payload** | **String** |  | [optional] |
+| **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
 | **gcp_key** | **String** | Base64-encoded service account private key text | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional] |
 | **keep_prev_version** | **String** |  | [optional] |
 | **key** | **String** | The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) | [optional] |
 | **name** | **String** | Secret name |  |
-| **new_metadata** | **String** | New item metadata | [optional][default to 'default_metadata'] |
+| **new_metadata** | **String** | Deprecated - use description | [optional][default to 'default_metadata'] |
 | **new_name** | **String** | New item name | [optional] |
 | **new_version** | **Boolean** | Deprecated | [optional] |
 | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
@@ -56,6 +57,7 @@ instance = Akeyless::UpdateRotatedSecret.new(
   auto_rotate: null,
   aws_region: null,
   custom_payload: null,
+  description: null,
   gcp_key: null,
   json: null,
   keep_prev_version: null,

data/docs/UpdateSSHCertIssuer.md

@@ -6,9 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
 | **allowed_users** | **String** | Users allowed to fetch the certificate, e.g root,ubuntu |  |
+| **description** | **String** | Description of the object | [optional] |
 | **extensions** | **Hash<String, String>** | Signed certificates with extensions, e.g permit-port-forwarding=\\\"\\\" | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional] |
-| **metadata** | **String** | A metadata about the issuer | [optional] |
+| **metadata** | **String** | Deprecated - use description | [optional] |
 | **name** | **String** | SSH certificate issuer name |  |
 | **new_name** | **String** | New item name | [optional] |
 | **principals** | **String** | Signed certificates with principal, e.g example_role1,example_role2 | [optional] |
@@ -32,6 +33,7 @@ require 'akeyless'
 instance = Akeyless::UpdateSSHCertIssuer.new(
   add_tag: null,
   allowed_users: null,
+  description: null,
   extensions: null,
   json: null,
   metadata: null,

data/docs/UploadPKCS12.md

@@ -6,9 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **customer_frg_id** | **String** | The customer fragment ID that will be used to split the key (if empty, the key will be created independently of a customer fragment) | [optional] |
 | **delete_protection** | **String** | Protection from accidental deletion of this item | [optional] |
+| **description** | **String** | Description of the object | [optional] |
 | **_in** | **String** | PKCS#12 input file (private key and certificate only) |  |
 | **json** | **Boolean** | Set output format to JSON | [optional] |
-| **metadata** | **String** | A metadata about the key | [optional] |
+| **metadata** | **String** | Deprecated - use description | [optional] |
 | **name** | **String** | Name of key to be created |  |
 | **passphrase** | **String** | Passphrase to unlock the pkcs#12 bundle |  |
 | **split_level** | **Integer** | The number of fragments that the item will be split into | [optional][default to 2] |
@@ -24,6 +25,7 @@ require 'akeyless'
 instance = Akeyless::UploadPKCS12.new(
   customer_frg_id: null,
   delete_protection: null,
+  description: null,
   _in: null,
   json: null,
   metadata: null,

data/docs/UploadRSA.md

@@ -8,8 +8,9 @@
 | **cert_file_data** | **String** | Certificate in a PEM format. | [optional] |
 | **customer_frg_id** | **String** | The customer fragment ID that will be used to split the key (if empty, the key will be created independently of a customer fragment) | [optional] |
 | **delete_protection** | **String** | Protection from accidental deletion of this item | [optional] |
+| **description** | **String** | Description of the object | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional] |
-| **metadata** | **String** | A metadata about the key | [optional] |
+| **metadata** | **String** | Deprecated - use description | [optional] |
 | **name** | **String** | Name of key to be created |  |
 | **overwrite** | **String** | When the overwrite flag is set, this command will only update an existing key. [true, false] | [optional] |
 | **rsa_file_data** | **String** | RSA private key data, base64 encoded | [optional] |
@@ -28,6 +29,7 @@ instance = Akeyless::UploadRSA.new(
   cert_file_data: null,
   customer_frg_id: null,
   delete_protection: null,
+  description: null,
   json: null,
   metadata: null,
   name: null,

data/docs/V2Api.md

@@ -49,6 +49,7 @@ All URIs are relative to *https://api.akeyless.io*
 | [**create_web_target**](V2Api.md#create_web_target) | **POST** /create-web-target |  |
 | [**createldap_target**](V2Api.md#createldap_target) | **POST** /create-ldap-target |  |
 | [**decrypt**](V2Api.md#decrypt) | **POST** /decrypt |  |
+| [**decrypt_gpg**](V2Api.md#decrypt_gpg) | **POST** /decrypt-gpg |  |
 | [**decrypt_pkcs1**](V2Api.md#decrypt_pkcs1) | **POST** /decrypt-pkcs1 |  |
 | [**decrypt_with_classic_key**](V2Api.md#decrypt_with_classic_key) | **POST** /decrypt-with-classic-key |  |
 | [**delete_auth_method**](V2Api.md#delete_auth_method) | **POST** /delete-auth-method |  |
@@ -68,6 +69,7 @@ All URIs are relative to *https://api.akeyless.io*
 | [**describe_sub_claims**](V2Api.md#describe_sub_claims) | **POST** /describe-sub-claims |  |
 | [**detokenize**](V2Api.md#detokenize) | **POST** /detokenize |  |
 | [**encrypt**](V2Api.md#encrypt) | **POST** /encrypt |  |
+| [**encrypt_gpg**](V2Api.md#encrypt_gpg) | **POST** /encrypt-gpg |  |
 | [**encrypt_with_classic_key**](V2Api.md#encrypt_with_classic_key) | **POST** /encrypt-with-classic-key |  |
 | [**export_classic_key**](V2Api.md#export_classic_key) | **POST** /export-classic-key |  |
 | [**gateway_create_k8_s_auth_config**](V2Api.md#gateway_create_k8_s_auth_config) | **POST** /gateway-create-k8s-auth-config |  |
@@ -191,6 +193,7 @@ All URIs are relative to *https://api.akeyless.io*
 | [**set_item_state**](V2Api.md#set_item_state) | **POST** /set-item-state |  |
 | [**set_role_rule**](V2Api.md#set_role_rule) | **POST** /set-role-rule |  |
 | [**share_item**](V2Api.md#share_item) | **POST** /share-item |  |
+| [**sign_gpg**](V2Api.md#sign_gpg) | **POST** /sign-gpg |  |
 | [**sign_jwt_with_classic_key**](V2Api.md#sign_jwt_with_classic_key) | **POST** /sign-jwt-with-classic-key |  |
 | [**sign_pkcs1**](V2Api.md#sign_pkcs1) | **POST** /sign-pkcs1 |  |
 | [**sign_pki_cert_with_classic_key**](V2Api.md#sign_pki_cert_with_classic_key) | **POST** /sign-pki-cert-with-classic-key |  |
@@ -249,6 +252,7 @@ All URIs are relative to *https://api.akeyless.io*
 | [**update_web_target_details**](V2Api.md#update_web_target_details) | **POST** /update-web-target-details |  |
 | [**upload_rsa**](V2Api.md#upload_rsa) | **POST** /upload-rsa |  |
 | [**validate_token**](V2Api.md#validate_token) | **POST** /validate-token |  |
+| [**verify_gpg**](V2Api.md#verify_gpg) | **POST** /verify-gpg |  |
 | [**verify_jwt_with_classic_key**](V2Api.md#verify_jwt_with_classic_key) | **POST** /verify-jwt-with-classic-key |  |
 | [**verify_pkcs1**](V2Api.md#verify_pkcs1) | **POST** /verify-pkcs1 |  |
 | [**verify_pki_cert_with_classic_key**](V2Api.md#verify_pki_cert_with_classic_key) | **POST** /verify-pki-cert-with-classic-key |  |
@@ -3044,6 +3048,68 @@ No authorization required
 - **Accept**: application/json
 
 
+## decrypt_gpg
+
+> <DecryptGPGOutput> decrypt_gpg(body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'akeyless'
+
+api_instance = Akeyless::V2Api.new
+body = Akeyless::DecryptGPG.new({ciphertext: 'ciphertext_example', key_name: 'key_name_example'}) # DecryptGPG | 
+
+begin
+  
+  result = api_instance.decrypt_gpg(body)
+  p result
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->decrypt_gpg: #{e}"
+end
+```
+
+#### Using the decrypt_gpg_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DecryptGPGOutput>, Integer, Hash)> decrypt_gpg_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.decrypt_gpg_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DecryptGPGOutput>
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->decrypt_gpg_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**DecryptGPG**](DecryptGPG.md) |  |  |
+
+### Return type
+
+[**DecryptGPGOutput**](DecryptGPGOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## decrypt_pkcs1
 
 > <DecryptPKCS1Output> decrypt_pkcs1(body)
@@ -4222,6 +4288,68 @@ No authorization required
 - **Accept**: application/json
 
 
+## encrypt_gpg
+
+> <EncryptGPGOutput> encrypt_gpg(body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'akeyless'
+
+api_instance = Akeyless::V2Api.new
+body = Akeyless::EncryptGPG.new({key_name: 'key_name_example', plaintext: 'plaintext_example'}) # EncryptGPG | 
+
+begin
+  
+  result = api_instance.encrypt_gpg(body)
+  p result
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->encrypt_gpg: #{e}"
+end
+```
+
+#### Using the encrypt_gpg_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EncryptGPGOutput>, Integer, Hash)> encrypt_gpg_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.encrypt_gpg_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EncryptGPGOutput>
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->encrypt_gpg_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**EncryptGPG**](EncryptGPG.md) |  |  |
+
+### Return type
+
+[**EncryptGPGOutput**](EncryptGPGOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## encrypt_with_classic_key
 
 > <EncryptOutput> encrypt_with_classic_key(body)
@@ -11872,6 +12000,68 @@ No authorization required
 - **Accept**: application/json
 
 
+## sign_gpg
+
+> <SignGPGOutput> sign_gpg(body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'akeyless'
+
+api_instance = Akeyless::V2Api.new
+body = Akeyless::SignGPG.new({key_name: 'key_name_example', message: 'message_example'}) # SignGPG | 
+
+begin
+  
+  result = api_instance.sign_gpg(body)
+  p result
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->sign_gpg: #{e}"
+end
+```
+
+#### Using the sign_gpg_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignGPGOutput>, Integer, Hash)> sign_gpg_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sign_gpg_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignGPGOutput>
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->sign_gpg_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**SignGPG**](SignGPG.md) |  |  |
+
+### Return type
+
+[**SignGPGOutput**](SignGPGOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## sign_jwt_with_classic_key
 
 > <SignJWTOutput> sign_jwt_with_classic_key(body)
@@ -15465,6 +15655,68 @@ No authorization required
 - **Accept**: application/json
 
 
+## verify_gpg
+
+> Object verify_gpg(body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'akeyless'
+
+api_instance = Akeyless::V2Api.new
+body = Akeyless::VerifyGPG.new({key_name: 'key_name_example', signature: 'signature_example'}) # VerifyGPG | 
+
+begin
+  
+  result = api_instance.verify_gpg(body)
+  p result
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->verify_gpg: #{e}"
+end
+```
+
+#### Using the verify_gpg_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> verify_gpg_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.verify_gpg_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Akeyless::ApiError => e
+  puts "Error when calling V2Api->verify_gpg_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**VerifyGPG**](VerifyGPG.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## verify_jwt_with_classic_key
 
 > <VerifyJWTOutput> verify_jwt_with_classic_key(body)

data/docs/VerifyGPG.md

@@ -0,0 +1,32 @@
+# Akeyless::VerifyGPG
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_id** | **String** | The display id of the key to use in the encryption process | [optional] |
+| **item_id** | **Integer** | The item id of the key to use in the encryption process | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional] |
+| **key_name** | **String** | The name of the key to use in the encryption process |  |
+| **passphrase** | **String** | Passphrase that was used to generate the key | [optional] |
+| **signature** | **String** | The signature to be verified in base64 format |  |
+| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
+| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
+
+## Example
+
+```ruby
+require 'akeyless'
+
+instance = Akeyless::VerifyGPG.new(
+  display_id: null,
+  item_id: null,
+  json: null,
+  key_name: null,
+  passphrase: null,
+  signature: null,
+  token: null,
+  uid_token: null
+)
+```
+