RubyGems - akeyless - Versions diffs - 4.0.0 → 4.2.0 - Mend

akeyless 4.0.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1318) hide show

data/docs/AuthMethodCreateAzureAD.md ADDED Viewed

@@ -0,0 +1,64 @@
+# Akeyless::AuthMethodCreateAzureAD
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audience** | **String** | Deprecated (Deprecated) The audience in the JWT | [optional][default to &#39;https://management.azure.com/&#39;] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_group_id** | **Array&lt;String&gt;** | A list of group ids that the access is restricted to | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **bound_providers** | **Array&lt;String&gt;** | A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc) | [optional] |
+| **bound_resource_id** | **Array&lt;String&gt;** | A list of full resource ids that the access is restricted to | [optional] |
+| **bound_resource_names** | **Array&lt;String&gt;** | A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc). | [optional] |
+| **bound_resource_types** | **Array&lt;String&gt;** | A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc) | [optional] |
+| **bound_rg_id** | **Array&lt;String&gt;** | A list of resource groups that the access is restricted to | [optional] |
+| **bound_spid** | **Array&lt;String&gt;** | A list of service principal IDs that the access is restricted to | [optional] |
+| **bound_sub_id** | **Array&lt;String&gt;** | A list of subscription ids that the access is restricted to | [optional] |
+| **bound_tenant_id** | **String** | The Azure tenant id that the access is restricted to |  |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **issuer** | **String** | Issuer URL | [optional][default to &#39;https://sts.windows.net/---bound_tenant_id---&#39;] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwks_uri** | **String** | The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. | [optional][default to &#39;https://login.microsoftonline.com/common/discovery/keys&#39;] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [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::AuthMethodCreateAzureAD.new(
+  access_expires: null,
+  audience: null,
+  audit_logs_claims: null,
+  bound_group_id: null,
+  bound_ips: null,
+  bound_providers: null,
+  bound_resource_id: null,
+  bound_resource_names: null,
+  bound_resource_types: null,
+  bound_rg_id: null,
+  bound_spid: null,
+  bound_sub_id: null,
+  bound_tenant_id: null,
+  description: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  issuer: null,
+  json: null,
+  jwks_uri: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  token: null,
+  uid_token: null
+)
+```

data/docs/AuthMethodCreateCert.md ADDED Viewed

@@ -0,0 +1,60 @@
+# Akeyless::AuthMethodCreateCert
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **allowed_cors** | **String** | Comma separated list of allowed CORS domains to be validated as part of the authentication flow. | [optional] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_common_names** | **Array&lt;String&gt;** | A list of names. At least one must exist in the Common Name. Supports globbing. | [optional] |
+| **bound_dns_sans** | **Array&lt;String&gt;** | A list of DNS names. At least one must exist in the SANs. Supports globbing. | [optional] |
+| **bound_email_sans** | **Array&lt;String&gt;** | A list of Email Addresses. At least one must exist in the SANs. Supports globbing. | [optional] |
+| **bound_extensions** | **Array&lt;String&gt;** | A list of extensions formatted as \&quot;oid:value\&quot;. Expects the extension value to be some type of ASN1 encoded string. All values much match. Supports globbing on \&quot;value\&quot;. | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **bound_organizational_units** | **Array&lt;String&gt;** | A list of Organizational Units names. At least one must exist in the OU field. | [optional] |
+| **bound_uri_sans** | **Array&lt;String&gt;** | A list of URIs. At least one must exist in the SANs. Supports globbing. | [optional] |
+| **certificate_data** | **String** | The certificate data in base64, if no file was provided | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **revoked_cert_ids** | **Array&lt;String&gt;** | A list of revoked cert ids | [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] |
+| **unique_identifier** | **String** | A unique identifier (ID) value should be configured, such as common_name or organizational_unit Whenever a user logs in with a token, these authentication types issue a \&quot;sub claim\&quot; that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. |  |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateCert.new(
+  access_expires: null,
+  allowed_cors: null,
+  audit_logs_claims: null,
+  bound_common_names: null,
+  bound_dns_sans: null,
+  bound_email_sans: null,
+  bound_extensions: null,
+  bound_ips: null,
+  bound_organizational_units: null,
+  bound_uri_sans: null,
+  certificate_data: null,
+  description: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  revoked_cert_ids: null,
+  token: null,
+  uid_token: null,
+  unique_identifier: null
+)
+```

data/docs/AuthMethodCreateEmail.md ADDED Viewed

@@ -0,0 +1,42 @@
+# Akeyless::AuthMethodCreateEmail
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **email** | **String** | An email address to be invited to have access |  |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [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::AuthMethodCreateEmail.new(
+  access_expires: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  description: null,
+  email: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  token: null,
+  uid_token: null
+)
+```

data/docs/AuthMethodCreateGcp.md ADDED Viewed

@@ -0,0 +1,56 @@
+# Akeyless::AuthMethodCreateGcp
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audience** | **String** | The audience to verify in the JWT received by the client | [default to &#39;akeyless.io&#39;] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **bound_labels** | **Array&lt;String&gt;** | A comma-separated list of GCP labels formatted as \&quot;key:value\&quot; strings that must be set on authorized GCE instances. TODO: Because GCP labels are not currently ACL&#39;d .... | [optional] |
+| **bound_projects** | **Array&lt;String&gt;** | &#x3D;&#x3D;&#x3D; Human and Machine authentication section &#x3D;&#x3D;&#x3D; Array of GCP project IDs. Only entities belonging to any of the provided projects can authenticate. | [optional] |
+| **bound_regions** | **Array&lt;String&gt;** | List of regions that a GCE instance must belong to in order to be authenticated. TODO: If bound_instance_groups is provided, it is assumed to be a regional group and the group must belong to this region. If bound_zones are provided, this attribute is ignored. | [optional] |
+| **bound_service_accounts** | **Array&lt;String&gt;** | List of service accounts the service account must be part of in order to be authenticated. | [optional] |
+| **bound_zones** | **Array&lt;String&gt;** | &#x3D;&#x3D;&#x3D; Machine authentication section &#x3D;&#x3D;&#x3D; List of zones that a GCE instance must belong to in order to be authenticated. TODO: If bound_instance_groups is provided, it is assumed to be a zonal group and the group must belong to this zone. | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **service_account_creds_data** | **String** | ServiceAccount credentials data instead of giving a file path, base64 encoded | [optional] |
+| **token** | **String** | Authentication token (see &#x60;/auth&#x60; and &#x60;/configure&#x60;) | [optional] |
+| **type** | **String** | Type of the GCP Access Rules |  |
+| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateGcp.new(
+  access_expires: null,
+  audience: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  bound_labels: null,
+  bound_projects: null,
+  bound_regions: null,
+  bound_service_accounts: null,
+  bound_zones: null,
+  description: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  service_account_creds_data: null,
+  token: null,
+  type: null,
+  uid_token: null
+)
+```

data/docs/AuthMethodCreateK8s.md ADDED Viewed

@@ -0,0 +1,52 @@
+# Akeyless::AuthMethodCreateK8s
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audience** | **String** | The audience in the Kubernetes JWT that the access is restricted to | [optional] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **bound_namespaces** | **Array&lt;String&gt;** | A list of namespaces that the access is restricted to | [optional] |
+| **bound_pod_names** | **Array&lt;String&gt;** | A list of pod names that the access is restricted to | [optional] |
+| **bound_sa_names** | **Array&lt;String&gt;** | A list of service account names that the access is restricted to | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gen_key** | **String** | Automatically generate key-pair for K8S configuration. If set to false, a public key needs to be provided [true/false] | [optional][default to &#39;true&#39;] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **public_key** | **String** | Base64-encoded or PEM formatted public key data for K8S authentication method is required [RSA2048] | [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::AuthMethodCreateK8s.new(
+  access_expires: null,
+  audience: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  bound_namespaces: null,
+  bound_pod_names: null,
+  bound_sa_names: null,
+  description: null,
+  force_sub_claims: null,
+  gen_key: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  public_key: null,
+  token: null,
+  uid_token: null
+)
+```

data/docs/AuthMethodCreateLdap.md ADDED Viewed

@@ -0,0 +1,46 @@
+# Akeyless::AuthMethodCreateLdap
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gen_key** | **String** | Automatically generate key-pair for LDAP configuration. If set to false, a public key needs to be provided [true/false] | [optional][default to &#39;true&#39;] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **public_key_data** | **String** | A public key generated for LDAP authentication method on Akeyless in base64 or PEM format [RSA2048] | [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] |
+| **unique_identifier** | **String** | A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a \&quot;sub claim\&quot; that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. | [optional][default to &#39;users&#39;] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateLdap.new(
+  access_expires: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  description: null,
+  force_sub_claims: null,
+  gen_key: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  public_key_data: null,
+  token: null,
+  uid_token: null,
+  unique_identifier: null
+)
+```

data/docs/AuthMethodCreateOCI.md ADDED Viewed

@@ -0,0 +1,44 @@
+# Akeyless::AuthMethodCreateOCI
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **group_ocid** | **Array&lt;String&gt;** | A list of required groups ocids |  |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **tenant_ocid** | **String** | The Oracle Cloud tenant ID |  |
+| **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::AuthMethodCreateOCI.new(
+  access_expires: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  description: null,
+  force_sub_claims: null,
+  group_ocid: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  tenant_ocid: null,
+  token: null,
+  uid_token: null
+)
+```

data/docs/AuthMethodCreateOIDC.md ADDED Viewed

@@ -0,0 +1,58 @@
+# Akeyless::AuthMethodCreateOIDC
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **allowed_redirect_uri** | **Array&lt;String&gt;** | Allowed redirect URIs after the authentication | [optional] |
+| **audience** | **String** | Audience claim to be used as part of the authentication flow. In case set, it must match the one configured on the Identity Provider&#39;s Application | [optional] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **client_id** | **String** | Client ID | [optional] |
+| **client_secret** | **String** | Client Secret | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **issuer** | **String** | Issuer URL | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **required_scopes** | **Array&lt;String&gt;** | RequiredScopes is a list of required scopes that the oidc method will request from the oidc provider and the user must approve | [optional] |
+| **required_scopes_prefix** | **String** | RequiredScopesPrefix is a a prefix to add to all required-scopes when requesting them from the oidc server (for example, azures&#39; Application ID URI) | [optional] |
+| **subclaims_delimiters** | **Array&lt;String&gt;** | A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) | [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] |
+| **unique_identifier** | **String** | A unique identifier (ID) value should be configured for OIDC, OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a \&quot;sub claim\&quot; that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. |  |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateOIDC.new(
+  access_expires: null,
+  allowed_redirect_uri: null,
+  audience: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  client_id: null,
+  client_secret: null,
+  description: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  issuer: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  required_scopes: null,
+  required_scopes_prefix: null,
+  subclaims_delimiters: null,
+  token: null,
+  uid_token: null,
+  unique_identifier: null
+)
+```

data/docs/AuthMethodCreateOauth2.md ADDED Viewed

@@ -0,0 +1,60 @@
+# Akeyless::AuthMethodCreateOauth2
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audience** | **String** | The audience in the JWT | [optional] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_client_ids** | **Array&lt;String&gt;** | The clients ids that the access is restricted to | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **cert** | **String** | CertificateFile Path to a file that contain the certificate in a PEM format. | [optional] |
+| **cert_file_data** | **String** | CertificateFileData PEM Certificate in a Base64 format. | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gateway_url** | **String** | Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway. | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **issuer** | **String** | Issuer URL | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwks_json_data** | **String** | The JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. base64 encoded string | [optional] |
+| **jwks_uri** | **String** | The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. | [default to &#39;default_jwks_url&#39;] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **subclaims_delimiters** | **Array&lt;String&gt;** | A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) | [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] |
+| **unique_identifier** | **String** | A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a \&quot;sub claim\&quot; that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. |  |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateOauth2.new(
+  access_expires: null,
+  audience: null,
+  audit_logs_claims: null,
+  bound_client_ids: null,
+  bound_ips: null,
+  cert: null,
+  cert_file_data: null,
+  description: null,
+  force_sub_claims: null,
+  gateway_url: null,
+  gw_bound_ips: null,
+  issuer: null,
+  json: null,
+  jwks_json_data: null,
+  jwks_uri: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  subclaims_delimiters: null,
+  token: null,
+  uid_token: null,
+  unique_identifier: null
+)
+```

data/docs/AuthMethodCreateOutput.md ADDED Viewed

@@ -0,0 +1,24 @@
+# Akeyless::AuthMethodCreateOutput
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_id** | **String** |  | [optional] |
+| **access_key** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **prv_key** | **String** |  | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateOutput.new(
+  access_id: null,
+  access_key: null,
+  name: null,
+  prv_key: null
+)
+```

data/docs/AuthMethodCreateSAML.md ADDED Viewed

@@ -0,0 +1,50 @@
+# Akeyless::AuthMethodCreateSAML
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **allowed_redirect_uri** | **Array&lt;String&gt;** | Allowed redirect URIs after the authentication | [optional] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **idp_metadata_url** | **String** | IDP metadata url | [optional] |
+| **idp_metadata_xml_data** | **String** | IDP metadata xml data | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **subclaims_delimiters** | **Array&lt;String&gt;** | A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) | [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] |
+| **unique_identifier** | **String** | A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a \&quot;sub claim\&quot; that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. |  |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateSAML.new(
+  access_expires: null,
+  allowed_redirect_uri: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  description: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  idp_metadata_url: null,
+  idp_metadata_xml_data: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  subclaims_delimiters: null,
+  token: null,
+  uid_token: null,
+  unique_identifier: null
+)
+```

data/docs/AuthMethodCreateUniversalIdentity.md ADDED Viewed

@@ -0,0 +1,46 @@
+# Akeyless::AuthMethodCreateUniversalIdentity
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
+| **audit_logs_claims** | **Array&lt;String&gt;** | Subclaims to include in audit logs, e.g \&quot;--audit-logs-claims email --audit-logs-claims username\&quot; | [optional] |
+| **bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
+| **deny_inheritance** | **Boolean** | Deny from root to create children | [optional] |
+| **deny_rotate** | **Boolean** | Deny from the token to rotate | [optional] |
+| **description** | **String** | Auth Method description | [optional] |
+| **force_sub_claims** | **Boolean** | if true: enforce role-association must include sub claims | [optional] |
+| **gw_bound_ips** | **Array&lt;String&gt;** | A CIDR whitelist with the GW IPs that the access is restricted to | [optional] |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **jwt_ttl** | **Integer** | Jwt TTL | [optional][default to 0] |
+| **name** | **String** | Auth Method name |  |
+| **product_type** | **Array&lt;String&gt;** | Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] | [optional] |
+| **token** | **String** | Authentication token (see &#x60;/auth&#x60; and &#x60;/configure&#x60;) | [optional] |
+| **ttl** | **Integer** | Token ttl | [optional][default to 60] |
+| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
+## Example
+```ruby
+require 'akeyless'
+instance = Akeyless::AuthMethodCreateUniversalIdentity.new(
+  access_expires: null,
+  audit_logs_claims: null,
+  bound_ips: null,
+  deny_inheritance: null,
+  deny_rotate: null,
+  description: null,
+  force_sub_claims: null,
+  gw_bound_ips: null,
+  json: null,
+  jwt_ttl: null,
+  name: null,
+  product_type: null,
+  token: null,
+  ttl: null,
+  uid_token: null
+)
+```

data/docs/AuthMethodDelete.md ADDED Viewed

@@ -0,0 +1,24 @@
+# Akeyless::AuthMethodDelete
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
+| **name** | **String** | Auth Method name |  |
+| **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::AuthMethodDelete.new(
+  json: null,
+  name: null,
+  token: null,
+  uid_token: null
+)
+```