akeyless 3.3.4 → 3.3.5
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.
- checksums.yaml +4 -4
- data/README.md +7 -1
- data/docs/CertificateTemplateInfo.md +32 -0
- data/docs/CreateClassicKey.md +16 -0
- data/docs/CreateDFCKey.md +16 -0
- data/docs/CreateKey.md +16 -0
- data/docs/DSProducerDetails.md +8 -2
- data/docs/DeriveKey.md +40 -0
- data/docs/DeriveKeyOutput.md +20 -0
- data/docs/EventAction.md +26 -0
- data/docs/GatewayCreateProducerCertificateAutomation.md +6 -4
- data/docs/GatewayUpdateProducerCertificateAutomation.md +6 -4
- data/docs/ItemGeneralInfo.md +2 -0
- data/docs/TargetTypeDetailsInput.md +8 -2
- data/docs/V2Api.md +126 -0
- data/lib/akeyless/api/v2_api.rb +128 -0
- data/lib/akeyless/models/certificate_template_info.rb +282 -0
- data/lib/akeyless/models/create_classic_key.rb +81 -1
- data/lib/akeyless/models/create_dfc_key.rb +81 -1
- data/lib/akeyless/models/create_key.rb +81 -1
- data/lib/akeyless/models/derive_key.rb +362 -0
- data/lib/akeyless/models/derive_key_output.rb +228 -0
- data/lib/akeyless/models/ds_producer_details.rb +30 -1
- data/lib/akeyless/models/event_action.rb +272 -0
- data/lib/akeyless/models/gateway_create_producer_certificate_automation.rb +30 -18
- data/lib/akeyless/models/gateway_update_producer_certificate_automation.rb +30 -18
- data/lib/akeyless/models/item_general_info.rb +10 -1
- data/lib/akeyless/models/target_type_details_input.rb +30 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +4 -0
- data/spec/models/certificate_template_info_spec.rb +76 -0
- data/spec/models/derive_key_output_spec.rb +40 -0
- data/spec/models/derive_key_spec.rb +100 -0
- data/spec/models/event_action_spec.rb +58 -0
- metadata +18 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f69d4a94f4bdba4ea27a4ec7fd6fffcf4621e9ec78edfb8484108326936de13d
|
4
|
+
data.tar.gz: 8a24bfe1e4bb4c147ba411ffea0ed89eea57492eeabbfe12d60cd018eeeae3af
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bedfd5f837c0335f293135a96106a7bc421a54ccf3fbc5fef2c6976cb13c35e315134eea0e3daf1ba0cd39ce841eabf821e8e20cca41e3852c2ca56c64b7150d
|
7
|
+
data.tar.gz: f6840a3d73af5356417b9334cdf47588913678a1d201a9cc3f22519e851bae8e9ad1bcf8f47b89fa31c0dd734bc0de8e2144751967e3b83410561b9e8fcb4529
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The purpose of this application is to provide access to Akeyless API.
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0
|
10
|
-
- Package version: 3.3.
|
10
|
+
- Package version: 3.3.5
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://akeyless.io](http://akeyless.io)
|
13
13
|
|
@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
|
|
127
127
|
*Akeyless::V2Api* | [**delete_target**](docs/V2Api.md#delete_target) | **POST** /delete-target |
|
128
128
|
*Akeyless::V2Api* | [**delete_target_association**](docs/V2Api.md#delete_target_association) | **POST** /delete-assoc-target-item |
|
129
129
|
*Akeyless::V2Api* | [**delete_targets**](docs/V2Api.md#delete_targets) | **POST** /delete-targets |
|
130
|
+
*Akeyless::V2Api* | [**derive_key**](docs/V2Api.md#derive_key) | **POST** /derive-key |
|
130
131
|
*Akeyless::V2Api* | [**describe_assoc**](docs/V2Api.md#describe_assoc) | **POST** /describe-role-am-assoc |
|
131
132
|
*Akeyless::V2Api* | [**describe_item**](docs/V2Api.md#describe_item) | **POST** /describe-item |
|
132
133
|
*Akeyless::V2Api* | [**describe_permissions**](docs/V2Api.md#describe_permissions) | **POST** /describe-permissions |
|
@@ -140,6 +141,7 @@ Class | Method | HTTP request | Description
|
|
140
141
|
*Akeyless::V2Api* | [**esm_get**](docs/V2Api.md#esm_get) | **POST** /esm-get |
|
141
142
|
*Akeyless::V2Api* | [**esm_list**](docs/V2Api.md#esm_list) | **POST** /esm-list |
|
142
143
|
*Akeyless::V2Api* | [**esm_update**](docs/V2Api.md#esm_update) | **POST** /esm-update |
|
144
|
+
*Akeyless::V2Api* | [**event_action**](docs/V2Api.md#event_action) | **POST** /event-action |
|
143
145
|
*Akeyless::V2Api* | [**export_classic_key**](docs/V2Api.md#export_classic_key) | **POST** /export-classic-key |
|
144
146
|
*Akeyless::V2Api* | [**gateway_create_k8_s_auth_config**](docs/V2Api.md#gateway_create_k8_s_auth_config) | **POST** /gateway-create-k8s-auth-config |
|
145
147
|
*Akeyless::V2Api* | [**gateway_create_migration**](docs/V2Api.md#gateway_create_migration) | **POST** /gateway-create-migration |
|
@@ -378,6 +380,7 @@ Class | Method | HTTP request | Description
|
|
378
380
|
- [Akeyless::CertificateExpirationEvent](docs/CertificateExpirationEvent.md)
|
379
381
|
- [Akeyless::CertificateInfo](docs/CertificateInfo.md)
|
380
382
|
- [Akeyless::CertificateIssueInfo](docs/CertificateIssueInfo.md)
|
383
|
+
- [Akeyless::CertificateTemplateInfo](docs/CertificateTemplateInfo.md)
|
381
384
|
- [Akeyless::ClassicKeyDetailsInfo](docs/ClassicKeyDetailsInfo.md)
|
382
385
|
- [Akeyless::ClassicKeyStatusInfo](docs/ClassicKeyStatusInfo.md)
|
383
386
|
- [Akeyless::ClassicKeyTargetInfo](docs/ClassicKeyTargetInfo.md)
|
@@ -513,6 +516,8 @@ Class | Method | HTTP request | Description
|
|
513
516
|
- [Akeyless::DeleteTarget](docs/DeleteTarget.md)
|
514
517
|
- [Akeyless::DeleteTargetAssociation](docs/DeleteTargetAssociation.md)
|
515
518
|
- [Akeyless::DeleteTargets](docs/DeleteTargets.md)
|
519
|
+
- [Akeyless::DeriveKey](docs/DeriveKey.md)
|
520
|
+
- [Akeyless::DeriveKeyOutput](docs/DeriveKeyOutput.md)
|
516
521
|
- [Akeyless::DescribeAssoc](docs/DescribeAssoc.md)
|
517
522
|
- [Akeyless::DescribeItem](docs/DescribeItem.md)
|
518
523
|
- [Akeyless::DescribePermissions](docs/DescribePermissions.md)
|
@@ -543,6 +548,7 @@ Class | Method | HTTP request | Description
|
|
543
548
|
- [Akeyless::EsmListSecretsOutput](docs/EsmListSecretsOutput.md)
|
544
549
|
- [Akeyless::EsmUpdate](docs/EsmUpdate.md)
|
545
550
|
- [Akeyless::EsmUpdateSecretOutput](docs/EsmUpdateSecretOutput.md)
|
551
|
+
- [Akeyless::EventAction](docs/EventAction.md)
|
546
552
|
- [Akeyless::ExportClassicKey](docs/ExportClassicKey.md)
|
547
553
|
- [Akeyless::ExportClassicKeyOutput](docs/ExportClassicKeyOutput.md)
|
548
554
|
- [Akeyless::Extension](docs/Extension.md)
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# Akeyless::CertificateTemplateInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **common_name** | **String** | | [optional] |
|
8
|
+
| **country** | **String** | | [optional] |
|
9
|
+
| **digest_algo** | **String** | | [optional] |
|
10
|
+
| **locality** | **String** | | [optional] |
|
11
|
+
| **organization** | **String** | | [optional] |
|
12
|
+
| **province** | **String** | | [optional] |
|
13
|
+
| **self_signed_enabled** | **Boolean** | | [optional] |
|
14
|
+
| **ttl** | **Integer** | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'akeyless'
|
20
|
+
|
21
|
+
instance = Akeyless::CertificateTemplateInfo.new(
|
22
|
+
common_name: null,
|
23
|
+
country: null,
|
24
|
+
digest_algo: null,
|
25
|
+
locality: null,
|
26
|
+
organization: null,
|
27
|
+
province: null,
|
28
|
+
self_signed_enabled: null,
|
29
|
+
ttl: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
data/docs/CreateClassicKey.md
CHANGED
@@ -6,8 +6,16 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **alg** | **String** | Classic Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, RSA1024, RSA2048, RSA3072, RSA4096, EC256, EC384, GPG] | |
|
8
8
|
| **cert_file_data** | **String** | Certificate in a PEM format. | [optional] |
|
9
|
+
| **certificate_common_name** | **String** | Common name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
10
|
+
| **certificate_country** | **String** | Country name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
11
|
+
| **certificate_digest_algo** | **String** | Digest algorithm to be used for the certificate key signing. Currently, we support only \"sha256\" so we hide this option for CLI. | [optional] |
|
12
|
+
| **certificate_locality** | **String** | Locality for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
13
|
+
| **certificate_organization** | **String** | Organization name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
14
|
+
| **certificate_province** | **String** | Province name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
15
|
+
| **certificate_ttl** | **Integer** | TTL in days for the generated certificate. Required only for generate-self-signed-certificate. | [optional] |
|
9
16
|
| **delete_protection** | **String** | Protection from accidental deletion of this item [true/false] | [optional] |
|
10
17
|
| **description** | **String** | Description of the object | [optional] |
|
18
|
+
| **generate_self_signed_certificate** | **Boolean** | Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided. | [optional] |
|
11
19
|
| **gpg_alg** | **String** | gpg alg: Relevant only if GPG key type selected; options: [RSA1024, RSA2048, RSA3072, RSA4096, Ed25519] | [optional] |
|
12
20
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
13
21
|
| **key_data** | **String** | Base64-encoded classic key value | [optional] |
|
@@ -26,8 +34,16 @@ require 'akeyless'
|
|
26
34
|
instance = Akeyless::CreateClassicKey.new(
|
27
35
|
alg: null,
|
28
36
|
cert_file_data: null,
|
37
|
+
certificate_common_name: null,
|
38
|
+
certificate_country: null,
|
39
|
+
certificate_digest_algo: null,
|
40
|
+
certificate_locality: null,
|
41
|
+
certificate_organization: null,
|
42
|
+
certificate_province: null,
|
43
|
+
certificate_ttl: null,
|
29
44
|
delete_protection: null,
|
30
45
|
description: null,
|
46
|
+
generate_self_signed_certificate: null,
|
31
47
|
gpg_alg: null,
|
32
48
|
json: null,
|
33
49
|
key_data: null,
|
data/docs/CreateDFCKey.md
CHANGED
@@ -5,9 +5,17 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **alg** | **String** | DFCKey type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024, RSA2048, RSA3072, RSA4096] | |
|
8
|
+
| **certificate_common_name** | **String** | Common name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
9
|
+
| **certificate_country** | **String** | Country name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
10
|
+
| **certificate_digest_algo** | **String** | Digest algorithm to be used for the certificate key signing. Currently, we support only \"sha256\" so we hide this option for CLI. | [optional] |
|
11
|
+
| **certificate_locality** | **String** | Locality for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
12
|
+
| **certificate_organization** | **String** | Organization name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
13
|
+
| **certificate_province** | **String** | Province name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
14
|
+
| **certificate_ttl** | **Integer** | TTL in days for the generated certificate. Required only for generate-self-signed-certificate. | [optional] |
|
8
15
|
| **customer_frg_id** | **String** | The customer fragment ID that will be used to create the DFC key (if empty, the key will be created independently of a customer fragment) | [optional] |
|
9
16
|
| **delete_protection** | **String** | Protection from accidental deletion of this item [true/false] | [optional] |
|
10
17
|
| **description** | **String** | Description of the object | [optional] |
|
18
|
+
| **generate_self_signed_certificate** | **Boolean** | Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided. | [optional] |
|
11
19
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
12
20
|
| **metadata** | **String** | Deprecated - use description | [optional] |
|
13
21
|
| **name** | **String** | DFCKey name | |
|
@@ -23,9 +31,17 @@ require 'akeyless'
|
|
23
31
|
|
24
32
|
instance = Akeyless::CreateDFCKey.new(
|
25
33
|
alg: null,
|
34
|
+
certificate_common_name: null,
|
35
|
+
certificate_country: null,
|
36
|
+
certificate_digest_algo: null,
|
37
|
+
certificate_locality: null,
|
38
|
+
certificate_organization: null,
|
39
|
+
certificate_province: null,
|
40
|
+
certificate_ttl: null,
|
26
41
|
customer_frg_id: null,
|
27
42
|
delete_protection: null,
|
28
43
|
description: null,
|
44
|
+
generate_self_signed_certificate: null,
|
29
45
|
json: null,
|
30
46
|
metadata: null,
|
31
47
|
name: null,
|
data/docs/CreateKey.md
CHANGED
@@ -5,9 +5,17 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **alg** | **String** | Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024, RSA2048, RSA3072, RSA4096] | |
|
8
|
+
| **certificate_common_name** | **String** | Common name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
9
|
+
| **certificate_country** | **String** | Country name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
10
|
+
| **certificate_digest_algo** | **String** | Digest algorithm to be used for the certificate key signing. Currently, we support only \"sha256\" so we hide this option for CLI. | [optional] |
|
11
|
+
| **certificate_locality** | **String** | Locality for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
12
|
+
| **certificate_organization** | **String** | Organization name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
13
|
+
| **certificate_province** | **String** | Province name for the generated certificate. Relevant only for generate-self-signed-certificate. | [optional] |
|
14
|
+
| **certificate_ttl** | **Integer** | TTL in days for the generated certificate. Required only for generate-self-signed-certificate. | [optional] |
|
8
15
|
| **customer_frg_id** | **String** | The customer fragment ID that will be used to create the key (if empty, the key will be created independently of a customer fragment) | [optional] |
|
9
16
|
| **delete_protection** | **String** | Protection from accidental deletion of this item [true/false] | [optional] |
|
10
17
|
| **description** | **String** | Description of the object | [optional] |
|
18
|
+
| **generate_self_signed_certificate** | **Boolean** | Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided. | [optional] |
|
11
19
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
12
20
|
| **metadata** | **String** | Deprecated - use description | [optional] |
|
13
21
|
| **name** | **String** | Key name | |
|
@@ -23,9 +31,17 @@ require 'akeyless'
|
|
23
31
|
|
24
32
|
instance = Akeyless::CreateKey.new(
|
25
33
|
alg: null,
|
34
|
+
certificate_common_name: null,
|
35
|
+
certificate_country: null,
|
36
|
+
certificate_digest_algo: null,
|
37
|
+
certificate_locality: null,
|
38
|
+
certificate_organization: null,
|
39
|
+
certificate_province: null,
|
40
|
+
certificate_ttl: null,
|
26
41
|
customer_frg_id: null,
|
27
42
|
delete_protection: null,
|
28
43
|
description: null,
|
44
|
+
generate_self_signed_certificate: null,
|
29
45
|
json: null,
|
30
46
|
metadata: null,
|
31
47
|
name: null,
|
data/docs/DSProducerDetails.md
CHANGED
@@ -204,8 +204,11 @@
|
|
204
204
|
| **venafi_sign_using_akeyless_pki** | **Boolean** | | [optional] |
|
205
205
|
| **venafi_signer_key_name** | **String** | | [optional] |
|
206
206
|
| **venafi_store_private_key** | **Boolean** | | [optional] |
|
207
|
-
| **
|
208
|
-
| **
|
207
|
+
| **venafi_tpp_access_token** | **String** | | [optional] |
|
208
|
+
| **venafi_tpp_client_id** | **String** | | [optional] |
|
209
|
+
| **venafi_tpp_password** | **String** | Deprecated: VenafiAccessToken and VenafiRefreshToken should be used instead | [optional] |
|
210
|
+
| **venafi_tpp_refresh_token** | **String** | | [optional] |
|
211
|
+
| **venafi_tpp_username** | **String** | Deprecated: VenafiAccessToken and VenafiRefreshToken should be used instead | [optional] |
|
209
212
|
| **venafi_use_tpp** | **Boolean** | | [optional] |
|
210
213
|
| **venafi_zone** | **String** | | [optional] |
|
211
214
|
| **warn_before_user_expiration_min** | **Integer** | | [optional] |
|
@@ -416,7 +419,10 @@ instance = Akeyless::DSProducerDetails.new(
|
|
416
419
|
venafi_sign_using_akeyless_pki: null,
|
417
420
|
venafi_signer_key_name: null,
|
418
421
|
venafi_store_private_key: null,
|
422
|
+
venafi_tpp_access_token: null,
|
423
|
+
venafi_tpp_client_id: null,
|
419
424
|
venafi_tpp_password: null,
|
425
|
+
venafi_tpp_refresh_token: null,
|
420
426
|
venafi_tpp_username: null,
|
421
427
|
venafi_use_tpp: null,
|
422
428
|
venafi_zone: null,
|
data/docs/DeriveKey.md
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# Akeyless::DeriveKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
|
+
| **alg** | **String** | Kdf algorithm | [default to 'pbkdf2'] |
|
9
|
+
| **hash_function** | **String** | HashFunction the hash function to use (relevant for pbkdf2) | [optional][default to 'sha256'] |
|
10
|
+
| **iter** | **Integer** | IterationCount the number of iterations | |
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
12
|
+
| **key_len** | **Integer** | KeyLength the byte length of the generated key | |
|
13
|
+
| **mem** | **Integer** | MemorySizeInKb the memory paramter in kb (relevant for argon2id) | [optional][default to 16384] |
|
14
|
+
| **name** | **String** | Static Secret full name | |
|
15
|
+
| **parallelism** | **Integer** | Parallelism the number of threads to use (relevant for argon2id) | [optional][default to 1] |
|
16
|
+
| **salt** | **String** | Salt Base64 encoded salt value. If not provided, the salt will be generated as part of the operation. The salt should be securely-generated random bytes, minimum 64 bits, 128 bits is recommended | [optional] |
|
17
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
18
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'akeyless'
|
24
|
+
|
25
|
+
instance = Akeyless::DeriveKey.new(
|
26
|
+
accessibility: null,
|
27
|
+
alg: null,
|
28
|
+
hash_function: null,
|
29
|
+
iter: null,
|
30
|
+
json: null,
|
31
|
+
key_len: null,
|
32
|
+
mem: null,
|
33
|
+
name: null,
|
34
|
+
parallelism: null,
|
35
|
+
salt: null,
|
36
|
+
token: null,
|
37
|
+
uid_token: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Akeyless::DeriveKeyOutput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **key** | **String** | | [optional] |
|
8
|
+
| **salt** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'akeyless'
|
14
|
+
|
15
|
+
instance = Akeyless::DeriveKeyOutput.new(
|
16
|
+
key: null,
|
17
|
+
salt: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/EventAction.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Akeyless::EventAction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **action** | **String** | The Event Action [approve/deny] | |
|
8
|
+
| **event_id** | **Integer** | The Event ID | |
|
9
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
10
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
11
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'akeyless'
|
17
|
+
|
18
|
+
instance = Akeyless::EventAction.new(
|
19
|
+
action: null,
|
20
|
+
event_id: null,
|
21
|
+
json: null,
|
22
|
+
token: null,
|
23
|
+
uid_token: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -22,11 +22,12 @@
|
|
22
22
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
23
23
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
24
24
|
| **user_ttl** | **String** | User TTL in time.Duration format (2160h / 129600m / etc...). When using sign-using-akeyless-pki certificates created will have this validity period, otherwise the user-ttl is taken from the Validity Period field of the Zone's' Issuing Template. When using cert-manager it is advised to have a TTL of above 60 days (1440h). For more information - https://cert-manager.io/docs/usage/certificate/ | [optional][default to '2160h'] |
|
25
|
+
| **venafi_access_token** | **String** | Venafi Access Token to use to access the TPP environment (Relevant when using TPP) | [optional] |
|
25
26
|
| **venafi_api_key** | **String** | Venafi API key | [optional] |
|
26
27
|
| **venafi_baseurl** | **String** | Venafi Baseurl | [optional] |
|
27
|
-
| **
|
28
|
+
| **venafi_client_id** | **String** | Venafi Client ID that was used when the access token was generated | [optional][default to 'akeyless'] |
|
29
|
+
| **venafi_refresh_token** | **String** | Venafi Refresh Token to use when the Access Token is expired (Relevant when using TPP) | [optional] |
|
28
30
|
| **venafi_use_tpp** | **Boolean** | Venafi using TPP | [optional] |
|
29
|
-
| **venafi_username** | **String** | Venafi Username | [optional] |
|
30
31
|
| **venafi_zone** | **String** | Venafi Zone | [optional] |
|
31
32
|
|
32
33
|
## Example
|
@@ -53,11 +54,12 @@ instance = Akeyless::GatewayCreateProducerCertificateAutomation.new(
|
|
53
54
|
token: null,
|
54
55
|
uid_token: null,
|
55
56
|
user_ttl: null,
|
57
|
+
venafi_access_token: null,
|
56
58
|
venafi_api_key: null,
|
57
59
|
venafi_baseurl: null,
|
58
|
-
|
60
|
+
venafi_client_id: null,
|
61
|
+
venafi_refresh_token: null,
|
59
62
|
venafi_use_tpp: null,
|
60
|
-
venafi_username: null,
|
61
63
|
venafi_zone: null
|
62
64
|
)
|
63
65
|
```
|
@@ -23,11 +23,12 @@
|
|
23
23
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
24
24
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
25
25
|
| **user_ttl** | **String** | User TTL in time.Duration format (2160h / 129600m / etc...). When using sign-using-akeyless-pki certificates created will have this validity period, otherwise the user-ttl is taken from the Validity Period field of the Zone's' Issuing Template. When using cert-manager it is advised to have a TTL of above 60 days (1440h). For more information - https://cert-manager.io/docs/usage/certificate/ | [optional][default to '2160h'] |
|
26
|
+
| **venafi_access_token** | **String** | Venafi Access Token to use to access the TPP environment (Relevant when using TPP) | [optional] |
|
26
27
|
| **venafi_api_key** | **String** | Venafi API key | [optional] |
|
27
28
|
| **venafi_baseurl** | **String** | Venafi Baseurl | [optional] |
|
28
|
-
| **
|
29
|
+
| **venafi_client_id** | **String** | Venafi Client ID that was used when the access token was generated | [optional][default to 'akeyless'] |
|
30
|
+
| **venafi_refresh_token** | **String** | Venafi Refresh Token to use when the Access Token is expired (Relevant when using TPP) | [optional] |
|
29
31
|
| **venafi_use_tpp** | **Boolean** | Venafi using TPP | [optional] |
|
30
|
-
| **venafi_username** | **String** | Venafi Username | [optional] |
|
31
32
|
| **venafi_zone** | **String** | Venafi Zone | [optional] |
|
32
33
|
|
33
34
|
## Example
|
@@ -55,11 +56,12 @@ instance = Akeyless::GatewayUpdateProducerCertificateAutomation.new(
|
|
55
56
|
token: null,
|
56
57
|
uid_token: null,
|
57
58
|
user_ttl: null,
|
59
|
+
venafi_access_token: null,
|
58
60
|
venafi_api_key: null,
|
59
61
|
venafi_baseurl: null,
|
60
|
-
|
62
|
+
venafi_client_id: null,
|
63
|
+
venafi_refresh_token: null,
|
61
64
|
venafi_use_tpp: null,
|
62
|
-
venafi_username: null,
|
63
65
|
venafi_zone: null
|
64
66
|
)
|
65
67
|
```
|
data/docs/ItemGeneralInfo.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **cert_issue_details** | [**CertificateIssueInfo**](CertificateIssueInfo.md) | | [optional] |
|
8
8
|
| **certificate_chain_info** | [**CertificateChainInfo**](CertificateChainInfo.md) | | [optional] |
|
9
|
+
| **certificates_template_info** | [**CertificateTemplateInfo**](CertificateTemplateInfo.md) | | [optional] |
|
9
10
|
| **classic_key_details** | [**ClassicKeyDetailsInfo**](ClassicKeyDetailsInfo.md) | | [optional] |
|
10
11
|
| **cluster_gw_url** | **String** | | [optional] |
|
11
12
|
| **display_metadata** | **String** | | [optional] |
|
@@ -25,6 +26,7 @@ require 'akeyless'
|
|
25
26
|
instance = Akeyless::ItemGeneralInfo.new(
|
26
27
|
cert_issue_details: null,
|
27
28
|
certificate_chain_info: null,
|
29
|
+
certificates_template_info: null,
|
28
30
|
classic_key_details: null,
|
29
31
|
cluster_gw_url: null,
|
30
32
|
display_metadata: null,
|
@@ -119,8 +119,11 @@
|
|
119
119
|
| **validation_email** | **String** | | [optional] |
|
120
120
|
| **venafi_api_key** | **String** | | [optional] |
|
121
121
|
| **venafi_base_url** | **String** | | [optional] |
|
122
|
-
| **
|
123
|
-
| **
|
122
|
+
| **venafi_tpp_access_token** | **String** | | [optional] |
|
123
|
+
| **venafi_tpp_client_id** | **String** | | [optional] |
|
124
|
+
| **venafi_tpp_password** | **String** | Deprecated: VenafiAccessToken and VenafiRefreshToken should be used instead | [optional] |
|
125
|
+
| **venafi_tpp_refresh_token** | **String** | | [optional] |
|
126
|
+
| **venafi_tpp_username** | **String** | Deprecated: VenafiAccessToken and VenafiRefreshToken should be used instead | [optional] |
|
124
127
|
| **venafi_use_tpp** | **Boolean** | | [optional] |
|
125
128
|
| **venafi_zone** | **String** | | [optional] |
|
126
129
|
|
@@ -245,7 +248,10 @@ instance = Akeyless::TargetTypeDetailsInput.new(
|
|
245
248
|
validation_email: null,
|
246
249
|
venafi_api_key: null,
|
247
250
|
venafi_base_url: null,
|
251
|
+
venafi_tpp_access_token: null,
|
252
|
+
venafi_tpp_client_id: null,
|
248
253
|
venafi_tpp_password: null,
|
254
|
+
venafi_tpp_refresh_token: null,
|
249
255
|
venafi_tpp_username: null,
|
250
256
|
venafi_use_tpp: null,
|
251
257
|
venafi_zone: null
|
data/docs/V2Api.md
CHANGED
@@ -72,6 +72,7 @@ All URIs are relative to *https://api.akeyless.io*
|
|
72
72
|
| [**delete_target**](V2Api.md#delete_target) | **POST** /delete-target | |
|
73
73
|
| [**delete_target_association**](V2Api.md#delete_target_association) | **POST** /delete-assoc-target-item | |
|
74
74
|
| [**delete_targets**](V2Api.md#delete_targets) | **POST** /delete-targets | |
|
75
|
+
| [**derive_key**](V2Api.md#derive_key) | **POST** /derive-key | |
|
75
76
|
| [**describe_assoc**](V2Api.md#describe_assoc) | **POST** /describe-role-am-assoc | |
|
76
77
|
| [**describe_item**](V2Api.md#describe_item) | **POST** /describe-item | |
|
77
78
|
| [**describe_permissions**](V2Api.md#describe_permissions) | **POST** /describe-permissions | |
|
@@ -85,6 +86,7 @@ All URIs are relative to *https://api.akeyless.io*
|
|
85
86
|
| [**esm_get**](V2Api.md#esm_get) | **POST** /esm-get | |
|
86
87
|
| [**esm_list**](V2Api.md#esm_list) | **POST** /esm-list | |
|
87
88
|
| [**esm_update**](V2Api.md#esm_update) | **POST** /esm-update | |
|
89
|
+
| [**event_action**](V2Api.md#event_action) | **POST** /event-action | |
|
88
90
|
| [**export_classic_key**](V2Api.md#export_classic_key) | **POST** /export-classic-key | |
|
89
91
|
| [**gateway_create_k8_s_auth_config**](V2Api.md#gateway_create_k8_s_auth_config) | **POST** /gateway-create-k8s-auth-config | |
|
90
92
|
| [**gateway_create_migration**](V2Api.md#gateway_create_migration) | **POST** /gateway-create-migration | |
|
@@ -4499,6 +4501,68 @@ No authorization required
|
|
4499
4501
|
- **Accept**: application/json
|
4500
4502
|
|
4501
4503
|
|
4504
|
+
## derive_key
|
4505
|
+
|
4506
|
+
> <DeriveKeyOutput> derive_key(body)
|
4507
|
+
|
4508
|
+
|
4509
|
+
|
4510
|
+
### Examples
|
4511
|
+
|
4512
|
+
```ruby
|
4513
|
+
require 'time'
|
4514
|
+
require 'akeyless'
|
4515
|
+
|
4516
|
+
api_instance = Akeyless::V2Api.new
|
4517
|
+
body = Akeyless::DeriveKey.new({alg: 'alg_example', iter: 3.56, key_len: 3.56, name: 'name_example'}) # DeriveKey |
|
4518
|
+
|
4519
|
+
begin
|
4520
|
+
|
4521
|
+
result = api_instance.derive_key(body)
|
4522
|
+
p result
|
4523
|
+
rescue Akeyless::ApiError => e
|
4524
|
+
puts "Error when calling V2Api->derive_key: #{e}"
|
4525
|
+
end
|
4526
|
+
```
|
4527
|
+
|
4528
|
+
#### Using the derive_key_with_http_info variant
|
4529
|
+
|
4530
|
+
This returns an Array which contains the response data, status code and headers.
|
4531
|
+
|
4532
|
+
> <Array(<DeriveKeyOutput>, Integer, Hash)> derive_key_with_http_info(body)
|
4533
|
+
|
4534
|
+
```ruby
|
4535
|
+
begin
|
4536
|
+
|
4537
|
+
data, status_code, headers = api_instance.derive_key_with_http_info(body)
|
4538
|
+
p status_code # => 2xx
|
4539
|
+
p headers # => { ... }
|
4540
|
+
p data # => <DeriveKeyOutput>
|
4541
|
+
rescue Akeyless::ApiError => e
|
4542
|
+
puts "Error when calling V2Api->derive_key_with_http_info: #{e}"
|
4543
|
+
end
|
4544
|
+
```
|
4545
|
+
|
4546
|
+
### Parameters
|
4547
|
+
|
4548
|
+
| Name | Type | Description | Notes |
|
4549
|
+
| ---- | ---- | ----------- | ----- |
|
4550
|
+
| **body** | [**DeriveKey**](DeriveKey.md) | | |
|
4551
|
+
|
4552
|
+
### Return type
|
4553
|
+
|
4554
|
+
[**DeriveKeyOutput**](DeriveKeyOutput.md)
|
4555
|
+
|
4556
|
+
### Authorization
|
4557
|
+
|
4558
|
+
No authorization required
|
4559
|
+
|
4560
|
+
### HTTP request headers
|
4561
|
+
|
4562
|
+
- **Content-Type**: application/json
|
4563
|
+
- **Accept**: application/json
|
4564
|
+
|
4565
|
+
|
4502
4566
|
## describe_assoc
|
4503
4567
|
|
4504
4568
|
> <RoleAssociationDetails> describe_assoc(body)
|
@@ -5302,6 +5366,68 @@ No authorization required
|
|
5302
5366
|
- **Accept**: application/json
|
5303
5367
|
|
5304
5368
|
|
5369
|
+
## event_action
|
5370
|
+
|
5371
|
+
> Object event_action(body)
|
5372
|
+
|
5373
|
+
|
5374
|
+
|
5375
|
+
### Examples
|
5376
|
+
|
5377
|
+
```ruby
|
5378
|
+
require 'time'
|
5379
|
+
require 'akeyless'
|
5380
|
+
|
5381
|
+
api_instance = Akeyless::V2Api.new
|
5382
|
+
body = Akeyless::EventAction.new({action: 'action_example', event_id: 3.56}) # EventAction |
|
5383
|
+
|
5384
|
+
begin
|
5385
|
+
|
5386
|
+
result = api_instance.event_action(body)
|
5387
|
+
p result
|
5388
|
+
rescue Akeyless::ApiError => e
|
5389
|
+
puts "Error when calling V2Api->event_action: #{e}"
|
5390
|
+
end
|
5391
|
+
```
|
5392
|
+
|
5393
|
+
#### Using the event_action_with_http_info variant
|
5394
|
+
|
5395
|
+
This returns an Array which contains the response data, status code and headers.
|
5396
|
+
|
5397
|
+
> <Array(Object, Integer, Hash)> event_action_with_http_info(body)
|
5398
|
+
|
5399
|
+
```ruby
|
5400
|
+
begin
|
5401
|
+
|
5402
|
+
data, status_code, headers = api_instance.event_action_with_http_info(body)
|
5403
|
+
p status_code # => 2xx
|
5404
|
+
p headers # => { ... }
|
5405
|
+
p data # => Object
|
5406
|
+
rescue Akeyless::ApiError => e
|
5407
|
+
puts "Error when calling V2Api->event_action_with_http_info: #{e}"
|
5408
|
+
end
|
5409
|
+
```
|
5410
|
+
|
5411
|
+
### Parameters
|
5412
|
+
|
5413
|
+
| Name | Type | Description | Notes |
|
5414
|
+
| ---- | ---- | ----------- | ----- |
|
5415
|
+
| **body** | [**EventAction**](EventAction.md) | | |
|
5416
|
+
|
5417
|
+
### Return type
|
5418
|
+
|
5419
|
+
**Object**
|
5420
|
+
|
5421
|
+
### Authorization
|
5422
|
+
|
5423
|
+
No authorization required
|
5424
|
+
|
5425
|
+
### HTTP request headers
|
5426
|
+
|
5427
|
+
- **Content-Type**: application/json
|
5428
|
+
- **Accept**: application/json
|
5429
|
+
|
5430
|
+
|
5305
5431
|
## export_classic_key
|
5306
5432
|
|
5307
5433
|
> <ExportClassicKeyOutput> export_classic_key(body)
|