akeyless 2.16.5 → 2.16.6

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 (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -1
  3. data/docs/CreateTokenizer.md +42 -0
  4. data/docs/CreateTokenizerOutput.md +18 -0
  5. data/docs/Detokenize.md +26 -0
  6. data/docs/DetokenizeOutput.md +18 -0
  7. data/docs/DynamicSecretProducerInfo.md +2 -0
  8. data/docs/EmailTokenizerInfo.md +22 -0
  9. data/docs/ItemGeneralInfo.md +5 -1
  10. data/docs/ListTargets.md +2 -0
  11. data/docs/LogForwardingConfigPart.md +0 -2
  12. data/docs/Producer.md +2 -0
  13. data/docs/RegexpTokenizerInfo.md +24 -0
  14. data/docs/RotateSecret.md +22 -0
  15. data/docs/RotatedSecretOutput.md +18 -0
  16. data/docs/SystemAccessCredentialsReplyObj.md +2 -0
  17. data/docs/Tokenize.md +26 -0
  18. data/docs/TokenizeOutput.md +20 -0
  19. data/docs/TokenizerInfo.md +18 -0
  20. data/docs/UpdateTokenizer.md +46 -0
  21. data/docs/UpdateTokenizerOutput.md +18 -0
  22. data/docs/V2Api.md +315 -0
  23. data/docs/VaultlessTokenizerInfo.md +28 -0
  24. data/lib/akeyless/api/v2_api.rb +320 -0
  25. data/lib/akeyless/models/create_tokenizer.rb +358 -0
  26. data/lib/akeyless/models/create_tokenizer_output.rb +219 -0
  27. data/lib/akeyless/models/detokenize.rb +271 -0
  28. data/lib/akeyless/models/detokenize_output.rb +219 -0
  29. data/lib/akeyless/models/dynamic_secret_producer_info.rb +10 -1
  30. data/lib/akeyless/models/email_tokenizer_info.rb +241 -0
  31. data/lib/akeyless/models/item_general_info.rb +22 -4
  32. data/lib/akeyless/models/list_targets.rb +13 -1
  33. data/lib/akeyless/models/log_forwarding_config_part.rb +1 -10
  34. data/lib/akeyless/models/producer.rb +10 -1
  35. data/lib/akeyless/models/regexp_tokenizer_info.rb +251 -0
  36. data/lib/akeyless/models/rotate_secret.rb +245 -0
  37. data/lib/akeyless/models/rotated_secret_output.rb +219 -0
  38. data/lib/akeyless/models/system_access_credentials_reply_obj.rb +11 -1
  39. data/lib/akeyless/models/tokenize.rb +271 -0
  40. data/lib/akeyless/models/tokenize_output.rb +228 -0
  41. data/lib/akeyless/models/tokenizer_info.rb +219 -0
  42. data/lib/akeyless/models/update_tokenizer.rb +382 -0
  43. data/lib/akeyless/models/update_tokenizer_output.rb +219 -0
  44. data/lib/akeyless/models/vaultless_tokenizer_info.rb +267 -0
  45. data/lib/akeyless/version.rb +1 -1
  46. data/lib/akeyless.rb +14 -0
  47. data/spec/models/create_tokenizer_output_spec.rb +34 -0
  48. data/spec/models/create_tokenizer_spec.rb +106 -0
  49. data/spec/models/detokenize_output_spec.rb +34 -0
  50. data/spec/models/detokenize_spec.rb +58 -0
  51. data/spec/models/email_tokenizer_info_spec.rb +46 -0
  52. data/spec/models/regexp_tokenizer_info_spec.rb +52 -0
  53. data/spec/models/rotate_secret_spec.rb +46 -0
  54. data/spec/models/rotated_secret_output_spec.rb +34 -0
  55. data/spec/models/tokenize_output_spec.rb +40 -0
  56. data/spec/models/tokenize_spec.rb +58 -0
  57. data/spec/models/tokenizer_info_spec.rb +34 -0
  58. data/spec/models/update_tokenizer_output_spec.rb +34 -0
  59. data/spec/models/update_tokenizer_spec.rb +118 -0
  60. data/spec/models/vaultless_tokenizer_info_spec.rb +64 -0
  61. metadata +533 -477
data/docs/V2Api.md CHANGED
@@ -43,6 +43,7 @@ All URIs are relative to *https://api.akeyless.io*
43
43
  | [**create_secret**](V2Api.md#create_secret) | **POST** /create-secret | |
44
44
  | [**create_ssh_cert_issuer**](V2Api.md#create_ssh_cert_issuer) | **POST** /create-ssh-cert-issuer | |
45
45
  | [**create_ssh_target**](V2Api.md#create_ssh_target) | **POST** /create-ssh-target | |
46
+ | [**create_tokenizer**](V2Api.md#create_tokenizer) | **POST** /create-tokenizer | |
46
47
  | [**create_web_target**](V2Api.md#create_web_target) | **POST** /create-web-target | |
47
48
  | [**createldap_target**](V2Api.md#createldap_target) | **POST** /create-ldap-target | |
48
49
  | [**decrypt**](V2Api.md#decrypt) | **POST** /decrypt | |
@@ -61,6 +62,7 @@ All URIs are relative to *https://api.akeyless.io*
61
62
  | [**delete_targets**](V2Api.md#delete_targets) | **POST** /delete-targets | |
62
63
  | [**describe_item**](V2Api.md#describe_item) | **POST** /describe-item | |
63
64
  | [**describe_permissions**](V2Api.md#describe_permissions) | **POST** /describe-permissions | |
65
+ | [**detokenize**](V2Api.md#detokenize) | **POST** /detokenize | |
64
66
  | [**encrypt**](V2Api.md#encrypt) | **POST** /encrypt | |
65
67
  | [**encrypt_pkcs1**](V2Api.md#encrypt_pkcs1) | **POST** /encrypt-pkcs1 | |
66
68
  | [**encrypt_with_classic_key**](V2Api.md#encrypt_with_classic_key) | **POST** /encrypt-with-classic-key | |
@@ -170,12 +172,14 @@ All URIs are relative to *https://api.akeyless.io*
170
172
  | [**revoke_creds**](V2Api.md#revoke_creds) | **POST** /revoke-creds | |
171
173
  | [**rollback_secret**](V2Api.md#rollback_secret) | **POST** /rollback-secret | |
172
174
  | [**rotate_key**](V2Api.md#rotate_key) | **POST** /rotate-key | |
175
+ | [**rotate_secret**](V2Api.md#rotate_secret) | **POST** /gateway-rotate-secret | |
173
176
  | [**set_item_state**](V2Api.md#set_item_state) | **POST** /set-item-state | |
174
177
  | [**set_role_rule**](V2Api.md#set_role_rule) | **POST** /set-role-rule | |
175
178
  | [**sign_jwt_with_classic_key**](V2Api.md#sign_jwt_with_classic_key) | **POST** /sign-jwt-with-classic-key | |
176
179
  | [**sign_pkcs1**](V2Api.md#sign_pkcs1) | **POST** /sign-pkcs1 | |
177
180
  | [**sign_pki_cert_with_classic_key**](V2Api.md#sign_pki_cert_with_classic_key) | **POST** /sign-pki-cert-with-classic-key | |
178
181
  | [**static_creds_auth**](V2Api.md#static_creds_auth) | **POST** /static-creds-auth | |
182
+ | [**tokenize**](V2Api.md#tokenize) | **POST** /tokenize | |
179
183
  | [**uid_create_child_token**](V2Api.md#uid_create_child_token) | **POST** /uid-create-child-token | |
180
184
  | [**uid_generate_token**](V2Api.md#uid_generate_token) | **POST** /uid-generate-token | |
181
185
  | [**uid_list_children**](V2Api.md#uid_list_children) | **POST** /uid-list-children | |
@@ -221,6 +225,7 @@ All URIs are relative to *https://api.akeyless.io*
221
225
  | [**update_ssh_target_details**](V2Api.md#update_ssh_target_details) | **POST** /update-ssh-target-details | |
222
226
  | [**update_target**](V2Api.md#update_target) | **POST** /update-target | |
223
227
  | [**update_target_details**](V2Api.md#update_target_details) | **POST** /update-target-details | |
228
+ | [**update_tokenizer**](V2Api.md#update_tokenizer) | **POST** /update-tokenizer | |
224
229
  | [**update_web_target**](V2Api.md#update_web_target) | **POST** /update-web-target | |
225
230
  | [**update_web_target_details**](V2Api.md#update_web_target_details) | **POST** /update-web-target-details | |
226
231
  | [**upload_rsa**](V2Api.md#upload_rsa) | **POST** /upload-rsa | |
@@ -2648,6 +2653,68 @@ No authorization required
2648
2653
  - **Accept**: application/json
2649
2654
 
2650
2655
 
2656
+ ## create_tokenizer
2657
+
2658
+ > <CreateTokenizerOutput> create_tokenizer(body)
2659
+
2660
+
2661
+
2662
+ ### Examples
2663
+
2664
+ ```ruby
2665
+ require 'time'
2666
+ require 'akeyless'
2667
+
2668
+ api_instance = Akeyless::V2Api.new
2669
+ body = Akeyless::CreateTokenizer.new({name: 'name_example', template_type: 'template_type_example', tokenizer_type: 'tokenizer_type_example'}) # CreateTokenizer |
2670
+
2671
+ begin
2672
+
2673
+ result = api_instance.create_tokenizer(body)
2674
+ p result
2675
+ rescue Akeyless::ApiError => e
2676
+ puts "Error when calling V2Api->create_tokenizer: #{e}"
2677
+ end
2678
+ ```
2679
+
2680
+ #### Using the create_tokenizer_with_http_info variant
2681
+
2682
+ This returns an Array which contains the response data, status code and headers.
2683
+
2684
+ > <Array(<CreateTokenizerOutput>, Integer, Hash)> create_tokenizer_with_http_info(body)
2685
+
2686
+ ```ruby
2687
+ begin
2688
+
2689
+ data, status_code, headers = api_instance.create_tokenizer_with_http_info(body)
2690
+ p status_code # => 2xx
2691
+ p headers # => { ... }
2692
+ p data # => <CreateTokenizerOutput>
2693
+ rescue Akeyless::ApiError => e
2694
+ puts "Error when calling V2Api->create_tokenizer_with_http_info: #{e}"
2695
+ end
2696
+ ```
2697
+
2698
+ ### Parameters
2699
+
2700
+ | Name | Type | Description | Notes |
2701
+ | ---- | ---- | ----------- | ----- |
2702
+ | **body** | [**CreateTokenizer**](CreateTokenizer.md) | | |
2703
+
2704
+ ### Return type
2705
+
2706
+ [**CreateTokenizerOutput**](CreateTokenizerOutput.md)
2707
+
2708
+ ### Authorization
2709
+
2710
+ No authorization required
2711
+
2712
+ ### HTTP request headers
2713
+
2714
+ - **Content-Type**: application/json
2715
+ - **Accept**: application/json
2716
+
2717
+
2651
2718
  ## create_web_target
2652
2719
 
2653
2720
  > <CreateWebTargetOutput> create_web_target(body)
@@ -3764,6 +3831,68 @@ No authorization required
3764
3831
  - **Accept**: application/json
3765
3832
 
3766
3833
 
3834
+ ## detokenize
3835
+
3836
+ > <DetokenizeOutput> detokenize(body)
3837
+
3838
+
3839
+
3840
+ ### Examples
3841
+
3842
+ ```ruby
3843
+ require 'time'
3844
+ require 'akeyless'
3845
+
3846
+ api_instance = Akeyless::V2Api.new
3847
+ body = Akeyless::Detokenize.new({ciphertext: 'ciphertext_example', tokenizer_name: 'tokenizer_name_example'}) # Detokenize |
3848
+
3849
+ begin
3850
+
3851
+ result = api_instance.detokenize(body)
3852
+ p result
3853
+ rescue Akeyless::ApiError => e
3854
+ puts "Error when calling V2Api->detokenize: #{e}"
3855
+ end
3856
+ ```
3857
+
3858
+ #### Using the detokenize_with_http_info variant
3859
+
3860
+ This returns an Array which contains the response data, status code and headers.
3861
+
3862
+ > <Array(<DetokenizeOutput>, Integer, Hash)> detokenize_with_http_info(body)
3863
+
3864
+ ```ruby
3865
+ begin
3866
+
3867
+ data, status_code, headers = api_instance.detokenize_with_http_info(body)
3868
+ p status_code # => 2xx
3869
+ p headers # => { ... }
3870
+ p data # => <DetokenizeOutput>
3871
+ rescue Akeyless::ApiError => e
3872
+ puts "Error when calling V2Api->detokenize_with_http_info: #{e}"
3873
+ end
3874
+ ```
3875
+
3876
+ ### Parameters
3877
+
3878
+ | Name | Type | Description | Notes |
3879
+ | ---- | ---- | ----------- | ----- |
3880
+ | **body** | [**Detokenize**](Detokenize.md) | | |
3881
+
3882
+ ### Return type
3883
+
3884
+ [**DetokenizeOutput**](DetokenizeOutput.md)
3885
+
3886
+ ### Authorization
3887
+
3888
+ No authorization required
3889
+
3890
+ ### HTTP request headers
3891
+
3892
+ - **Content-Type**: application/json
3893
+ - **Accept**: application/json
3894
+
3895
+
3767
3896
  ## encrypt
3768
3897
 
3769
3898
  > <EncryptOutput> encrypt(body)
@@ -10546,6 +10675,68 @@ No authorization required
10546
10675
  - **Accept**: application/json
10547
10676
 
10548
10677
 
10678
+ ## rotate_secret
10679
+
10680
+ > <RotatedSecretOutput> rotate_secret(body)
10681
+
10682
+
10683
+
10684
+ ### Examples
10685
+
10686
+ ```ruby
10687
+ require 'time'
10688
+ require 'akeyless'
10689
+
10690
+ api_instance = Akeyless::V2Api.new
10691
+ body = Akeyless::RotateSecret.new({name: 'name_example'}) # RotateSecret |
10692
+
10693
+ begin
10694
+
10695
+ result = api_instance.rotate_secret(body)
10696
+ p result
10697
+ rescue Akeyless::ApiError => e
10698
+ puts "Error when calling V2Api->rotate_secret: #{e}"
10699
+ end
10700
+ ```
10701
+
10702
+ #### Using the rotate_secret_with_http_info variant
10703
+
10704
+ This returns an Array which contains the response data, status code and headers.
10705
+
10706
+ > <Array(<RotatedSecretOutput>, Integer, Hash)> rotate_secret_with_http_info(body)
10707
+
10708
+ ```ruby
10709
+ begin
10710
+
10711
+ data, status_code, headers = api_instance.rotate_secret_with_http_info(body)
10712
+ p status_code # => 2xx
10713
+ p headers # => { ... }
10714
+ p data # => <RotatedSecretOutput>
10715
+ rescue Akeyless::ApiError => e
10716
+ puts "Error when calling V2Api->rotate_secret_with_http_info: #{e}"
10717
+ end
10718
+ ```
10719
+
10720
+ ### Parameters
10721
+
10722
+ | Name | Type | Description | Notes |
10723
+ | ---- | ---- | ----------- | ----- |
10724
+ | **body** | [**RotateSecret**](RotateSecret.md) | | |
10725
+
10726
+ ### Return type
10727
+
10728
+ [**RotatedSecretOutput**](RotatedSecretOutput.md)
10729
+
10730
+ ### Authorization
10731
+
10732
+ No authorization required
10733
+
10734
+ ### HTTP request headers
10735
+
10736
+ - **Content-Type**: application/json
10737
+ - **Accept**: application/json
10738
+
10739
+
10549
10740
  ## set_item_state
10550
10741
 
10551
10742
  > Object set_item_state(body)
@@ -10918,6 +11109,68 @@ No authorization required
10918
11109
  - **Accept**: application/json
10919
11110
 
10920
11111
 
11112
+ ## tokenize
11113
+
11114
+ > <TokenizeOutput> tokenize(body)
11115
+
11116
+
11117
+
11118
+ ### Examples
11119
+
11120
+ ```ruby
11121
+ require 'time'
11122
+ require 'akeyless'
11123
+
11124
+ api_instance = Akeyless::V2Api.new
11125
+ body = Akeyless::Tokenize.new({plaintext: 'plaintext_example', tokenizer_name: 'tokenizer_name_example'}) # Tokenize |
11126
+
11127
+ begin
11128
+
11129
+ result = api_instance.tokenize(body)
11130
+ p result
11131
+ rescue Akeyless::ApiError => e
11132
+ puts "Error when calling V2Api->tokenize: #{e}"
11133
+ end
11134
+ ```
11135
+
11136
+ #### Using the tokenize_with_http_info variant
11137
+
11138
+ This returns an Array which contains the response data, status code and headers.
11139
+
11140
+ > <Array(<TokenizeOutput>, Integer, Hash)> tokenize_with_http_info(body)
11141
+
11142
+ ```ruby
11143
+ begin
11144
+
11145
+ data, status_code, headers = api_instance.tokenize_with_http_info(body)
11146
+ p status_code # => 2xx
11147
+ p headers # => { ... }
11148
+ p data # => <TokenizeOutput>
11149
+ rescue Akeyless::ApiError => e
11150
+ puts "Error when calling V2Api->tokenize_with_http_info: #{e}"
11151
+ end
11152
+ ```
11153
+
11154
+ ### Parameters
11155
+
11156
+ | Name | Type | Description | Notes |
11157
+ | ---- | ---- | ----------- | ----- |
11158
+ | **body** | [**Tokenize**](Tokenize.md) | | |
11159
+
11160
+ ### Return type
11161
+
11162
+ [**TokenizeOutput**](TokenizeOutput.md)
11163
+
11164
+ ### Authorization
11165
+
11166
+ No authorization required
11167
+
11168
+ ### HTTP request headers
11169
+
11170
+ - **Content-Type**: application/json
11171
+ - **Accept**: application/json
11172
+
11173
+
10921
11174
  ## uid_create_child_token
10922
11175
 
10923
11176
  > <UidCreateChildTokenOutput> uid_create_child_token(body)
@@ -13705,6 +13958,68 @@ No authorization required
13705
13958
  - **Accept**: application/json
13706
13959
 
13707
13960
 
13961
+ ## update_tokenizer
13962
+
13963
+ > <UpdateTokenizerOutput> update_tokenizer(body)
13964
+
13965
+
13966
+
13967
+ ### Examples
13968
+
13969
+ ```ruby
13970
+ require 'time'
13971
+ require 'akeyless'
13972
+
13973
+ api_instance = Akeyless::V2Api.new
13974
+ body = Akeyless::UpdateTokenizer.new({name: 'name_example', template_type: 'template_type_example', tokenizer_type: 'tokenizer_type_example'}) # UpdateTokenizer |
13975
+
13976
+ begin
13977
+
13978
+ result = api_instance.update_tokenizer(body)
13979
+ p result
13980
+ rescue Akeyless::ApiError => e
13981
+ puts "Error when calling V2Api->update_tokenizer: #{e}"
13982
+ end
13983
+ ```
13984
+
13985
+ #### Using the update_tokenizer_with_http_info variant
13986
+
13987
+ This returns an Array which contains the response data, status code and headers.
13988
+
13989
+ > <Array(<UpdateTokenizerOutput>, Integer, Hash)> update_tokenizer_with_http_info(body)
13990
+
13991
+ ```ruby
13992
+ begin
13993
+
13994
+ data, status_code, headers = api_instance.update_tokenizer_with_http_info(body)
13995
+ p status_code # => 2xx
13996
+ p headers # => { ... }
13997
+ p data # => <UpdateTokenizerOutput>
13998
+ rescue Akeyless::ApiError => e
13999
+ puts "Error when calling V2Api->update_tokenizer_with_http_info: #{e}"
14000
+ end
14001
+ ```
14002
+
14003
+ ### Parameters
14004
+
14005
+ | Name | Type | Description | Notes |
14006
+ | ---- | ---- | ----------- | ----- |
14007
+ | **body** | [**UpdateTokenizer**](UpdateTokenizer.md) | | |
14008
+
14009
+ ### Return type
14010
+
14011
+ [**UpdateTokenizerOutput**](UpdateTokenizerOutput.md)
14012
+
14013
+ ### Authorization
14014
+
14015
+ No authorization required
14016
+
14017
+ ### HTTP request headers
14018
+
14019
+ - **Content-Type**: application/json
14020
+ - **Accept**: application/json
14021
+
14022
+
13708
14023
  ## update_web_target
13709
14024
 
13710
14025
  > <UpdateWebTargetOutput> update_web_target(body)
@@ -0,0 +1,28 @@
1
+ # Akeyless::VaultlessTokenizerInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email_tokenizer_info** | [**EmailTokenizerInfo**](EmailTokenizerInfo.md) | | [optional] |
8
+ | **key_name** | **String** | | [optional] |
9
+ | **regexp_tokenizer_info** | [**RegexpTokenizerInfo**](RegexpTokenizerInfo.md) | | [optional] |
10
+ | **template_type** | **String** | | [optional] |
11
+ | **tweak** | **Array&lt;Integer&gt;** | Tweak used in the case of internal tweak type | [optional] |
12
+ | **tweak_type** | **String** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'akeyless'
18
+
19
+ instance = Akeyless::VaultlessTokenizerInfo.new(
20
+ email_tokenizer_info: null,
21
+ key_name: null,
22
+ regexp_tokenizer_info: null,
23
+ template_type: null,
24
+ tweak: null,
25
+ tweak_type: null
26
+ )
27
+ ```
28
+