RubyGems - akeyless - Versions diffs - 4.2.4 → 4.3.0 - Mend

akeyless 4.2.4 → 4.3.0

Files changed (1163) hide show

data/docs/KubeconfigGenerateOutput.md ADDED Viewed

@@ -0,0 +1,22 @@
+# Akeyless::KubeconfigGenerateOutput
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conflicted_clusters_names** | **Array&lt;String&gt;** |  | [optional] |
+| **data** | [**KubeConfigValue**](KubeConfigValue.md) |  | [optional] |
+| **errors** | **Array&lt;String&gt;** |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::KubeconfigGenerateOutput.new(
+  conflicted_clusters_names: null,
+  data: null,
+  errors: null
+)
+```

data/docs/KubeconfigNamedCluster.md ADDED Viewed

@@ -0,0 +1,20 @@
+# Akeyless::KubeconfigNamedCluster
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster** | [**KubeconfigCluster**](KubeconfigCluster.md) |  | [optional] |
+| **name** | **String** |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::KubeconfigNamedCluster.new(
+  cluster: null,
+  name: null
+)
+```

data/docs/KubeconfigNamedContext.md ADDED Viewed

@@ -0,0 +1,20 @@
+# Akeyless::KubeconfigNamedContext
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **context** | [**KubeconfigContext**](KubeconfigContext.md) |  | [optional] |
+| **name** | **String** |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::KubeconfigNamedContext.new(
+  context: null,
+  name: null
+)
+```

data/docs/KubeconfigUser.md ADDED Viewed

@@ -0,0 +1,20 @@
+# Akeyless::KubeconfigUser
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **user** | [**KubeconfigUserExec**](KubeconfigUserExec.md) |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::KubeconfigUser.new(
+  name: null,
+  user: null
+)
+```

data/docs/KubeconfigUserExec.md ADDED Viewed

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

data/docs/ListAcmeAccounts.md ADDED Viewed

@@ -0,0 +1,24 @@
+# Akeyless::ListAcmeAccounts
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cert_issuer_name** | **String** | The name of the PKI certificate issuer |  |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **token** | **String** | Authentication token (see &#x60;/auth&#x60; and &#x60;/configure&#x60;) | [optional] |
+| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::ListAcmeAccounts.new(
+  cert_issuer_name: null,
+  json: null,
+  token: null,
+  uid_token: null
+)
+```

data/docs/ListAcmeAccountsOutput.md ADDED Viewed

@@ -0,0 +1,18 @@
+# Akeyless::ListAcmeAccountsOutput
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accounts** | [**Array&lt;AcmeAccount&gt;**](AcmeAccount.md) |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::ListAcmeAccountsOutput.new(
+  accounts: null
+)
+```

data/docs/ListSRASessions.md ADDED Viewed

@@ -0,0 +1,26 @@
+# Akeyless::ListSRASessions
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **resource_type** | **Array&lt;String&gt;** | session resource type. In case it is empty, all resources type will be returned. options: [mysql, k8s, ssh, mongodb, mssql, postgres, aws, eks, gke, rdp] | [optional] |
+| **status_type** | **Array&lt;String&gt;** | session status type. In case it is empty, only active sessions will be returned. options: [connecting, connected, failed, completed, terminated] | [optional] |
+| **token** | **String** | Authentication token (see &#x60;/auth&#x60; and &#x60;/configure&#x60;) | [optional] |
+| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::ListSRASessions.new(
+  json: null,
+  resource_type: null,
+  status_type: null,
+  token: null,
+  uid_token: null
+)
+```

data/docs/ListSraSessionsOutput.md ADDED Viewed

@@ -0,0 +1,22 @@
+# Akeyless::ListSraSessionsOutput
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed_gateways** | **Array&lt;String&gt;** |  | [optional] |
+| **next_page** | **String** |  | [optional] |
+| **sessions** | [**Array&lt;SraSessionEntryOut&gt;**](SraSessionEntryOut.md) |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::ListSraSessionsOutput.new(
+  allowed_gateways: null,
+  next_page: null,
+  sessions: null
+)
+```

data/docs/PKICertificateIssueDetails.md CHANGED Viewed

@@ -4,12 +4,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **acme_enabled** | **Boolean** |  | [optional] |
 | **allow_any_name** | **Boolean** |  | [optional] |
 | **allow_copy_ext_from_csr** | **Boolean** |  | [optional] |
 | **allow_subdomains** | **Boolean** |  | [optional] |
 | **allowed_domains_list** | **Array&lt;String&gt;** |  | [optional] |
 | **allowed_extra_extensions** | **Hash&lt;String, Array&lt;String&gt;&gt;** |  | [optional] |
 | **allowed_uri_sans** | **Array&lt;String&gt;** |  | [optional] |
+| **auto_renew_certificate** | **Boolean** |  | [optional] |
 | **basic_constraints_valid_for_non_ca** | **Boolean** |  | [optional] |
 | **certificate_authority_mode** | **String** |  | [optional] |
 | **client_flag** | **Boolean** |  | [optional] |
@@ -27,12 +29,14 @@
 | **key_type** | **String** |  | [optional] |
 | **key_usage_list** | **Array&lt;String&gt;** |  | [optional] |
 | **locality** | **Array&lt;String&gt;** |  | [optional] |
+| **non_critical_key_usage** | **Boolean** |  | [optional] |
 | **not_before_duration** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
 | **organization_list** | **Array&lt;String&gt;** |  | [optional] |
 | **organization_unit_list** | **Array&lt;String&gt;** |  | [optional] |
 | **postal_code** | **Array&lt;String&gt;** |  | [optional] |
 | **protect_generated_certificates** | **Boolean** | ProtectGeneratedCertificates dictates whether the created certificates should be protected from deletion | [optional] |
 | **province** | **Array&lt;String&gt;** |  | [optional] |
+| **renew_before_expiration_in_days** | **Integer** |  | [optional] |
 | **require_cn** | **Boolean** |  | [optional] |
 | **server_flag** | **Boolean** |  | [optional] |
 | **street_address** | **Array&lt;String&gt;** |  | [optional] |
@@ -43,12 +47,14 @@
 require 'akeyless'
 instance = Akeyless::PKICertificateIssueDetails.new(
+  acme_enabled: null,
   allow_any_name: null,
   allow_copy_ext_from_csr: null,
   allow_subdomains: null,
   allowed_domains_list: null,
   allowed_extra_extensions: null,
   allowed_uri_sans: null,
+  auto_renew_certificate: null,
   basic_constraints_valid_for_non_ca: null,
   certificate_authority_mode: null,
   client_flag: null,
@@ -66,12 +72,14 @@ instance = Akeyless::PKICertificateIssueDetails.new(
   key_type: null,
   key_usage_list: null,
   locality: null,
+  non_critical_key_usage: null,
   not_before_duration: null,
   organization_list: null,
   organization_unit_list: null,
   postal_code: null,
   protect_generated_certificates: null,
   province: null,
+  renew_before_expiration_in_days: null,
   require_cn: null,
   server_flag: null,
   street_address: null

data/docs/RoleAssociationDetails.md CHANGED Viewed

@@ -7,6 +7,7 @@
 | **assoc_id** | **String** |  | [optional] |
 | **auth_method_name** | **String** |  | [optional] |
 | **auth_method_sub_claims** | **Hash&lt;String, Array&lt;String&gt;&gt;** |  | [optional] |
+| **is_subclaims_with_operator** | **Boolean** |  | [optional] |
 | **role_name** | **String** |  | [optional] |
 | **sub_claims_case_sensitive** | **Boolean** |  | [optional] |
@@ -19,6 +20,7 @@ instance = Akeyless::RoleAssociationDetails.new(
   assoc_id: null,
   auth_method_name: null,
   auth_method_sub_claims: null,
+  is_subclaims_with_operator: null,
   role_name: null,
   sub_claims_case_sensitive: null
 )

data/docs/RoleAuthMethodAssociation.md CHANGED Viewed

@@ -8,6 +8,7 @@
 | **auth_method_access_id** | **String** |  | [optional] |
 | **auth_method_name** | **String** |  | [optional] |
 | **auth_method_sub_claims** | **Hash&lt;String, Array&lt;String&gt;&gt;** |  | [optional] |
+| **is_subclaims_with_operator** | **Boolean** |  | [optional] |
 | **sub_claims_case_sensitive** | **Boolean** |  | [optional] |
 ## Example
@@ -20,6 +21,7 @@ instance = Akeyless::RoleAuthMethodAssociation.new(
   auth_method_access_id: null,
   auth_method_name: null,
   auth_method_sub_claims: null,
+  is_subclaims_with_operator: null,
   sub_claims_case_sensitive: null
 )
 ```

data/docs/SignEcDsa.md CHANGED Viewed

@@ -4,6 +4,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **accessibility** | **String** | for personal password manager | [optional][default to &#39;regular&#39;] |
 | **display_id** | **String** | The display id of the EC key to use for the signing process | [optional] |
 | **item_id** | **Integer** | The item id of the EC key to use for the signing process | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
@@ -20,6 +21,7 @@
 require 'akeyless'
 instance = Akeyless::SignEcDsa.new(
+  accessibility: null,
   display_id: null,
   item_id: null,
   json: null,

data/docs/SraSessionEntryOut.md ADDED Viewed

@@ -0,0 +1,46 @@
+# Akeyless::SraSessionEntryOut
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_id** | **String** |  | [optional] |
+| **client_type** | **String** |  | [optional] |
+| **cluster_unique_id** | **Integer** |  | [optional] |
+| **connection_type** | **String** |  | [optional] |
+| **end_time** | **Time** |  | [optional] |
+| **error_msg** | **String** |  | [optional] |
+| **gateway_name** | **String** |  | [optional] |
+| **instance_id** | **String** |  | [optional] |
+| **secret_name** | **String** |  | [optional] |
+| **session_id** | **String** |  | [optional] |
+| **start_time** | **Time** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **target_host** | **String** |  | [optional] |
+| **ttl** | **String** |  | [optional] |
+| **user_identifier** | **String** |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::SraSessionEntryOut.new(
+  access_id: null,
+  client_type: null,
+  cluster_unique_id: null,
+  connection_type: null,
+  end_time: null,
+  error_msg: null,
+  gateway_name: null,
+  instance_id: null,
+  secret_name: null,
+  session_id: null,
+  start_time: null,
+  status: null,
+  target_host: null,
+  ttl: null,
+  user_identifier: null
+)
+```

data/docs/UpdateClassicKeyCertificate.md CHANGED Viewed

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **cert_file_data** | **String** | PEM Certificate in a Base64 format. Used for updating RSA keys&#39; certificates. | [optional] |
+| **certificate_format** | **String** |  | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
 | **name** | **String** | ClassicKey name |  |
 | **token** | **String** | Authentication token (see &#x60;/auth&#x60; and &#x60;/configure&#x60;) | [optional] |
@@ -17,6 +18,7 @@ require 'akeyless'
 instance = Akeyless::UpdateClassicKeyCertificate.new(
   cert_file_data: null,
+  certificate_format: null,
   json: null,
   name: null,
   token: null,

data/docs/UpdateItem.md CHANGED Viewed

@@ -8,6 +8,7 @@
 | **accessibility** | **String** | for personal password manager | [optional][default to &#39;regular&#39;] |
 | **add_tag** | **Array&lt;String&gt;** | 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&#39; certificates. | [optional] |
+| **certificate_format** | **String** |  | [optional] |
 | **change_event** | **String** | Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret) | [optional] |
 | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
 | **description** | **String** | Description of the object | [optional][default to &#39;default_metadata&#39;] |
@@ -58,6 +59,7 @@ instance = Akeyless::UpdateItem.new(
   accessibility: null,
   add_tag: null,
   cert_file_data: null,
+  certificate_format: null,
   change_event: null,
   delete_protection: null,
   description: null,

data/docs/UpdatePKICertIssuer.md CHANGED Viewed

@@ -11,16 +11,19 @@
 | **allowed_domains** | **String** | A list of the allowed domains that clients can request to be included in the certificate (in a comma-delimited list) | [optional] |
 | **allowed_extra_extensions** | **String** | A json string containing the allowed extra extensions for the pki cert issuer | [optional] |
 | **allowed_uri_sans** | **String** | A list of the allowed URIs that clients can request to be included in the certificate as part of the URI Subject Alternative Names (in a comma-delimited list) | [optional] |
+| **auto_renew** | **Boolean** | Automatically renew certificates before expiration | [optional] |
 | **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 countries that will be set in the issued certificate | [optional] |
 | **create_private_crl** | **Boolean** | Set this to allow the issuer will expose a CRL endpoint in the Gateway | [optional] |
 | **create_public_crl** | **Boolean** | Set this to allow the cert issuer will expose a public CRL endpoint | [optional] |
+| **critical_key_usage** | **String** | Mark key usage as critical [true/false] | [optional][default to &#39;true&#39;] |
 | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
 | **description** | **String** | Description of the object | [optional] |
 | **destination_path** | **String** | A path in which to save generated certificates | [optional] |
+| **enable_acme** | **Boolean** | If set, the cert issuer will support the acme protocol | [optional] |
 | **expiration_event_in** | **Array&lt;String&gt;** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
-| **gw_cluster_url** | **String** | The GW cluster URL to issue the certificate from, required in Public CA mode or to allow CRLs on private CA | [optional] |
+| **gw_cluster_url** | **String** | The GW cluster URL to issue the certificate from. Required in Public CA mode, to allow CRLs on private CA, or to enable ACME | [optional] |
 | **is_ca** | **Boolean** | If set, the basic constraints extension will be added to certificate | [optional] |
 | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
 | **key_usage** | **String** | key-usage | [optional][default to &#39;DigitalSignature,KeyAgreement,KeyEncipherment&#39;] |
@@ -36,6 +39,7 @@
 | **protect_certificates** | **Boolean** | Whether to protect generated certificates from deletion | [optional] |
 | **province** | **String** | A comma-separated list of provinces that will be set in the issued certificate | [optional] |
 | **rm_tag** | **Array&lt;String&gt;** | List of the existent tags that will be removed from this item | [optional] |
+| **scheduled_renew** | **Integer** | Number of days before expiration to renew certificates | [optional] |
 | **server_flag** | **Boolean** | If set, certificates will be flagged for server auth use | [optional] |
 | **signer_key_name** | **String** | A key to sign the certificate with, required in Private CA mode | [default to &#39;dummy_signer_key&#39;] |
 | **street_address** | **String** | A comma-separated list of street addresses that will be set in the issued certificate | [optional] |
@@ -56,14 +60,17 @@ instance = Akeyless::UpdatePKICertIssuer.new(
   allowed_domains: null,
   allowed_extra_extensions: null,
   allowed_uri_sans: null,
+  auto_renew: null,
   client_flag: null,
   code_signing_flag: null,
   country: null,
   create_private_crl: null,
   create_public_crl: null,
+  critical_key_usage: null,
   delete_protection: null,
   description: null,
   destination_path: null,
+  enable_acme: null,
   expiration_event_in: null,
   gw_cluster_url: null,
   is_ca: null,
@@ -81,6 +88,7 @@ instance = Akeyless::UpdatePKICertIssuer.new(
   protect_certificates: null,
   province: null,
   rm_tag: null,
+  scheduled_renew: null,
   server_flag: null,
   signer_key_name: null,
   street_address: null,