akeyless 3.1.1 → 3.2.0

data/docs/SignGPG.md

@@ -0,0 +1,32 @@
+# Akeyless::SignGPG
+
+## 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 |  |
+| **message** | **String** | The message to be signed in base64 format |  |
+| **passphrase** | **String** | Passphrase that was used to generate the key | [optional] |
+| **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::SignGPG.new(
+  display_id: null,
+  item_id: null,
+  json: null,
+  key_name: null,
+  message: null,
+  passphrase: null,
+  token: null,
+  uid_token: null
+)
+```
+

data/docs/SignGPGOutput.md

@@ -0,0 +1,18 @@
+# Akeyless::SignGPGOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'akeyless'
+
+instance = Akeyless::SignGPGOutput.new(
+  result: null
+)
+```
+

data/docs/TargetTypeDetailsInput.md

@@ -4,11 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **administrative_port** | **String** |  | [optional] |
 | **app_private_key** | **Array<Integer>** | params needed for jwt auth AppPrivateKey is the rsa private key in PEM format | [optional] |
 | **artifactory_admin_apikey** | **String** |  | [optional] |
 | **artifactory_admin_username** | **String** |  | [optional] |
 | **artifactory_base_url** | **String** |  | [optional] |
 | **auth_flow** | **String** |  | [optional] |
+| **authorization_port** | **String** |  | [optional] |
 | **aws_access_key_id** | **String** |  | [optional] |
 | **aws_region** | **String** |  | [optional] |
 | **aws_secret_access_key** | **String** |  | [optional] |
@@ -32,6 +34,8 @@
 | **db_host_name** | **String** |  | [optional] |
 | **db_name** | **String** |  | [optional] |
 | **db_port** | **String** |  | [optional] |
+| **db_private_key** | **String** | (Optional) Private Key in PEM format | [optional] |
+| **db_private_key_passphrase** | **String** |  | [optional] |
 | **db_pwd** | **String** |  | [optional] |
 | **db_server_certificates** | **String** | (Optional) DBServerCertificates defines the set of root certificate authorities that clients use when verifying server certificates. If DBServerCertificates is empty, TLS uses the host's root CA set. | [optional] |
 | **db_server_name** | **String** | (Optional) ServerName is used to verify the hostname on the returned certificates unless InsecureSkipVerify is given. It is also included in the client's handshake to support virtual hosting unless it is an IP address. | [optional] |
@@ -76,9 +80,11 @@
 | **mongodb_username** | **String** |  | [optional] |
 | **password** | **String** |  | [optional] |
 | **payload** | **String** |  | [optional] |
+| **ping_url** | **String** |  | [optional] |
 | **port** | **String** |  | [optional] |
 | **private_key** | **String** |  | [optional] |
 | **private_key_password** | **String** |  | [optional] |
+| **privileged_user** | **String** |  | [optional] |
 | **rabbitmq_server_password** | **String** |  | [optional] |
 | **rabbitmq_server_uri** | **String** |  | [optional] |
 | **rabbitmq_server_user** | **String** |  | [optional] |
@@ -90,6 +96,7 @@
 | **url** | **String** |  | [optional] |
 | **use_gw_cloud_identity** | **Boolean** |  | [optional] |
 | **user_name** | **String** |  | [optional] |
+| **user_password** | **String** |  | [optional] |
 | **username** | **String** |  | [optional] |
 | **venafi_api_key** | **String** |  | [optional] |
 | **venafi_base_url** | **String** |  | [optional] |
@@ -104,11 +111,13 @@
 require 'akeyless'
 
 instance = Akeyless::TargetTypeDetailsInput.new(
+  administrative_port: null,
   app_private_key: null,
   artifactory_admin_apikey: null,
   artifactory_admin_username: null,
   artifactory_base_url: null,
   auth_flow: null,
+  authorization_port: null,
   aws_access_key_id: null,
   aws_region: null,
   aws_secret_access_key: null,
@@ -132,6 +141,8 @@ instance = Akeyless::TargetTypeDetailsInput.new(
   db_host_name: null,
   db_name: null,
   db_port: null,
+  db_private_key: null,
+  db_private_key_passphrase: null,
   db_pwd: null,
   db_server_certificates: null,
   db_server_name: null,
@@ -176,9 +187,11 @@ instance = Akeyless::TargetTypeDetailsInput.new(
   mongodb_username: null,
   password: null,
   payload: null,
+  ping_url: null,
   port: null,
   private_key: null,
   private_key_password: null,
+  privileged_user: null,
   rabbitmq_server_password: null,
   rabbitmq_server_uri: null,
   rabbitmq_server_user: null,
@@ -190,6 +203,7 @@ instance = Akeyless::TargetTypeDetailsInput.new(
   url: null,
   use_gw_cloud_identity: null,
   user_name: null,
+  user_password: null,
   username: null,
   venafi_api_key: null,
   venafi_base_url: null,

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/UpdatePingTarget.md

@@ -0,0 +1,44 @@
+# Akeyless::UpdatePingTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **administrative_port** | **String** | Ping Federate administrative port | [optional][default to '9999'] |
+| **authorization_port** | **String** | Ping Federate authorization port | [optional][default to '9031'] |
+| **comment** | **String** | Comment about the target | [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 target secret value (if empty, the account default protectionKey key will be used) | [optional] |
+| **name** | **String** | Target name |  |
+| **new_name** | **String** | New target name | [optional] |
+| **password** | **String** | Ping Federate privileged user password | [optional] |
+| **ping_url** | **String** | Ping URL | [optional] |
+| **privileged_user** | **String** | Ping Federate privileged user | [optional] |
+| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
+| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
+| **update_version** | **Boolean** | Deprecated | [optional] |
+
+## Example
+
+```ruby
+require 'akeyless'
+
+instance = Akeyless::UpdatePingTarget.new(
+  administrative_port: null,
+  authorization_port: null,
+  comment: null,
+  json: null,
+  keep_prev_version: null,
+  key: null,
+  name: null,
+  new_name: null,
+  password: null,
+  ping_url: null,
+  privileged_user: null,
+  token: null,
+  uid_token: null,
+  update_version: null
+)
+```
+

data/docs/UpdateRotatedSecret.md

@@ -10,15 +10,17 @@
 | **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] |
+| **rotate_after_disconnect** | **String** | Rotate the value of the secret after SRA session ends | [optional][default to 'false'] |
 | **rotated_password** | **String** |  | [optional] |
 | **rotated_username** | **String** |  | [optional] |
 | **rotation_hour** | **Integer** |  | [optional] |
@@ -56,6 +58,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,
@@ -65,6 +68,7 @@ instance = Akeyless::UpdateRotatedSecret.new(
   new_name: null,
   new_version: null,
   rm_tag: null,
+  rotate_after_disconnect: null,
   rotated_password: null,
   rotated_username: null,
   rotation_hour: 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,