akeyless 2.20.1 → 2.20.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +6 -3
- data/docs/AuthMethodRoleAssociation.md +2 -0
- data/docs/CreateAuthMethodOIDC.md +2 -0
- data/docs/CreateSecret.md +1 -1
- data/docs/DeleteItem.md +1 -1
- data/docs/ExportClassicKey.md +26 -0
- data/docs/ExportClassicKeyOutput.md +20 -0
- data/docs/GatewayCreateMigration.md +0 -8
- data/docs/GatewayUpdateMigration.md +0 -8
- data/docs/GetSecretValue.md +1 -3
- data/docs/ListItems.md +1 -1
- data/docs/MigrationGeneral.md +3 -1
- data/docs/OIDCAccessRules.md +2 -0
- data/docs/ReverseRBACClient.md +0 -2
- data/docs/RotateSecret.md +1 -1
- data/docs/ShareItem.md +34 -0
- data/docs/SmInfo.md +3 -3
- data/docs/SraInfo.md +3 -3
- data/docs/UpdateAuthMethodOIDC.md +2 -0
- data/docs/UpdateItem.md +1 -1
- data/docs/UpdateSecretVal.md +1 -1
- data/docs/V2Api.md +125 -0
- data/docs/VaultlessTokenizerInfo.md +1 -1
- data/lib/akeyless/api/v2_api.rb +128 -0
- data/lib/akeyless/models/auth_method_role_association.rb +12 -1
- data/lib/akeyless/models/create_auth_method_oidc.rb +11 -1
- data/lib/akeyless/models/create_secret.rb +2 -0
- data/lib/akeyless/models/delete_item.rb +2 -0
- data/lib/akeyless/models/export_classic_key.rb +266 -0
- data/lib/akeyless/models/export_classic_key_output.rb +228 -0
- data/lib/akeyless/models/gateway_create_migration.rb +1 -39
- data/lib/akeyless/models/gateway_update_migration.rb +1 -39
- data/lib/akeyless/models/get_secret_value.rb +3 -10
- data/lib/akeyless/models/list_items.rb +2 -0
- data/lib/akeyless/models/migration_general.rb +13 -4
- data/lib/akeyless/models/oidc_access_rules.rb +11 -1
- data/lib/akeyless/models/reverse_rbac_client.rb +1 -12
- data/lib/akeyless/models/rotate_secret.rb +1 -1
- data/lib/akeyless/models/share_item.rb +316 -0
- data/lib/akeyless/models/sm_info.rb +8 -7
- data/lib/akeyless/models/sra_info.rb +8 -7
- data/lib/akeyless/models/update_auth_method_oidc.rb +11 -1
- data/lib/akeyless/models/update_item.rb +2 -0
- data/lib/akeyless/models/update_secret_val.rb +2 -0
- data/lib/akeyless/models/vaultless_tokenizer_info.rb +2 -4
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +3 -2
- data/spec/models/export_classic_key_output_spec.rb +40 -0
- data/spec/models/export_classic_key_spec.rb +58 -0
- data/spec/models/share_item_spec.rb +82 -0
- metadata +530 -518
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: df3a77c936dec3cccf1223c96c29e7a38b828787786863e973d9ab4e30fc550d
|
4
|
+
data.tar.gz: 5fba737501a68589fd50b262862f53f40283a39bcb67bfb5ba50f1549bcdc77f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 90c47aeaaf50134c3e4a19e80322acdbe45fa362b2495d986d86efaa3c9191c8a889d229cf4b1552a643aac50a63de70268bc586203961777457a1f4fdf002f3
|
7
|
+
data.tar.gz: fec97496d7f50197c809c9851619459ca3496318d58838d077ca897b3a0fea3f9df8b3525e4836fd1f646eaf0bc38e30c5b7b77d28c1b005da63638230da40d9
|
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: 2.20.
|
10
|
+
- Package version: 2.20.2
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://akeyless.io](http://akeyless.io)
|
13
13
|
|
@@ -121,6 +121,7 @@ Class | Method | HTTP request | Description
|
|
121
121
|
*Akeyless::V2Api* | [**detokenize**](docs/V2Api.md#detokenize) | **POST** /detokenize |
|
122
122
|
*Akeyless::V2Api* | [**encrypt**](docs/V2Api.md#encrypt) | **POST** /encrypt |
|
123
123
|
*Akeyless::V2Api* | [**encrypt_with_classic_key**](docs/V2Api.md#encrypt_with_classic_key) | **POST** /encrypt-with-classic-key |
|
124
|
+
*Akeyless::V2Api* | [**export_classic_key**](docs/V2Api.md#export_classic_key) | **GET** /export-classic-key |
|
124
125
|
*Akeyless::V2Api* | [**gateway_add_allowed_management_access**](docs/V2Api.md#gateway_add_allowed_management_access) | **POST** /gateway-add-allow-management-access |
|
125
126
|
*Akeyless::V2Api* | [**gateway_create_k8_s_auth_config**](docs/V2Api.md#gateway_create_k8_s_auth_config) | **POST** /gateway-create-k8s-auth-config |
|
126
127
|
*Akeyless::V2Api* | [**gateway_create_migration**](docs/V2Api.md#gateway_create_migration) | **POST** /gateway-create-migration |
|
@@ -237,6 +238,7 @@ Class | Method | HTTP request | Description
|
|
237
238
|
*Akeyless::V2Api* | [**rotate_secret**](docs/V2Api.md#rotate_secret) | **POST** /gateway-rotate-secret |
|
238
239
|
*Akeyless::V2Api* | [**set_item_state**](docs/V2Api.md#set_item_state) | **POST** /set-item-state |
|
239
240
|
*Akeyless::V2Api* | [**set_role_rule**](docs/V2Api.md#set_role_rule) | **POST** /set-role-rule |
|
241
|
+
*Akeyless::V2Api* | [**share_item**](docs/V2Api.md#share_item) | **POST** /share-item |
|
240
242
|
*Akeyless::V2Api* | [**sign_jwt_with_classic_key**](docs/V2Api.md#sign_jwt_with_classic_key) | **POST** /sign-jwt-with-classic-key |
|
241
243
|
*Akeyless::V2Api* | [**sign_pkcs1**](docs/V2Api.md#sign_pkcs1) | **POST** /sign-pkcs1 |
|
242
244
|
*Akeyless::V2Api* | [**sign_pki_cert_with_classic_key**](docs/V2Api.md#sign_pki_cert_with_classic_key) | **POST** /sign-pki-cert-with-classic-key |
|
@@ -460,6 +462,8 @@ Class | Method | HTTP request | Description
|
|
460
462
|
- [Akeyless::EncryptOutput](docs/EncryptOutput.md)
|
461
463
|
- [Akeyless::EncryptWithClassicKey](docs/EncryptWithClassicKey.md)
|
462
464
|
- [Akeyless::EncryptWithClassicKeyOutput](docs/EncryptWithClassicKeyOutput.md)
|
465
|
+
- [Akeyless::ExportClassicKey](docs/ExportClassicKey.md)
|
466
|
+
- [Akeyless::ExportClassicKeyOutput](docs/ExportClassicKeyOutput.md)
|
463
467
|
- [Akeyless::ExternalKMSKeyId](docs/ExternalKMSKeyId.md)
|
464
468
|
- [Akeyless::GCPAccessRules](docs/GCPAccessRules.md)
|
465
469
|
- [Akeyless::GCPPayload](docs/GCPPayload.md)
|
@@ -611,8 +615,6 @@ Class | Method | HTTP request | Description
|
|
611
615
|
- [Akeyless::GetAccountSettings](docs/GetAccountSettings.md)
|
612
616
|
- [Akeyless::GetAccountSettingsCommandOutput](docs/GetAccountSettingsCommandOutput.md)
|
613
617
|
- [Akeyless::GetAuthMethod](docs/GetAuthMethod.md)
|
614
|
-
- [Akeyless::GetCloudIdentity](docs/GetCloudIdentity.md)
|
615
|
-
- [Akeyless::GetCloudIdentityOutput](docs/GetCloudIdentityOutput.md)
|
616
618
|
- [Akeyless::GetDynamicSecretValue](docs/GetDynamicSecretValue.md)
|
617
619
|
- [Akeyless::GetKubeExecCreds](docs/GetKubeExecCreds.md)
|
618
620
|
- [Akeyless::GetKubeExecCredsOutput](docs/GetKubeExecCredsOutput.md)
|
@@ -739,6 +741,7 @@ Class | Method | HTTP request | Description
|
|
739
741
|
- [Akeyless::SecureRemoteAccess](docs/SecureRemoteAccess.md)
|
740
742
|
- [Akeyless::SetItemState](docs/SetItemState.md)
|
741
743
|
- [Akeyless::SetRoleRule](docs/SetRoleRule.md)
|
744
|
+
- [Akeyless::ShareItem](docs/ShareItem.md)
|
742
745
|
- [Akeyless::SignJWTOutput](docs/SignJWTOutput.md)
|
743
746
|
- [Akeyless::SignJWTWithClassicKey](docs/SignJWTWithClassicKey.md)
|
744
747
|
- [Akeyless::SignPKCS1](docs/SignPKCS1.md)
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allowed_ops** | **Array<String>** | | [optional] |
|
7
8
|
| **assoc_id** | **String** | | [optional] |
|
8
9
|
| **auth_method_sub_claims** | **Hash<String, Array<String>>** | | [optional] |
|
9
10
|
| **role_name** | **String** | | [optional] |
|
@@ -15,6 +16,7 @@
|
|
15
16
|
require 'akeyless'
|
16
17
|
|
17
18
|
instance = Akeyless::AuthMethodRoleAssociation.new(
|
19
|
+
allowed_ops: null,
|
18
20
|
assoc_id: null,
|
19
21
|
auth_method_sub_claims: null,
|
20
22
|
role_name: null,
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
|
8
8
|
| **allowed_redirect_uri** | **Array<String>** | Allowed redirect URIs after the authentication | [optional] |
|
9
|
+
| **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's Application | [optional] |
|
9
10
|
| **bound_ips** | **Array<String>** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
|
10
11
|
| **client_id** | **String** | Client ID | [optional] |
|
11
12
|
| **client_secret** | **String** | Client Secret | [optional] |
|
@@ -29,6 +30,7 @@ require 'akeyless'
|
|
29
30
|
instance = Akeyless::CreateAuthMethodOIDC.new(
|
30
31
|
access_expires: null,
|
31
32
|
allowed_redirect_uri: null,
|
33
|
+
audience: null,
|
32
34
|
bound_ips: null,
|
33
35
|
client_id: null,
|
34
36
|
client_secret: null,
|
data/docs/CreateSecret.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accessibility** | **String** | for personal password manager | [optional] |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this item | [optional] |
|
9
9
|
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
10
10
|
| **metadata** | **String** | Metadata about the secret | [optional] |
|
data/docs/DeleteItem.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accessibility** | **String** | for personal password manager | [optional] |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
8
|
| **delete_immediately** | **Boolean** | When delete-in-days=-1, must be set | [optional][default to false] |
|
9
9
|
| **delete_in_days** | **Integer** | The number of days to wait before deleting the item (relevant for keys only) | [optional][default to 7] |
|
10
10
|
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Akeyless::ExportClassicKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
8
|
+
| **name** | **String** | ClassicKey name | |
|
9
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
10
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
11
|
+
| **version** | **Integer** | Classic key version | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'akeyless'
|
17
|
+
|
18
|
+
instance = Akeyless::ExportClassicKey.new(
|
19
|
+
json: null,
|
20
|
+
name: null,
|
21
|
+
token: null,
|
22
|
+
uid_token: null,
|
23
|
+
version: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Akeyless::ExportClassicKeyOutput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **certificate_pem** | **String** | | [optional] |
|
8
|
+
| **key** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'akeyless'
|
14
|
+
|
15
|
+
instance = Akeyless::ExportClassicKeyOutput.new(
|
16
|
+
certificate_pem: null,
|
17
|
+
key: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -9,10 +9,6 @@
|
|
9
9
|
| **_1password_secret_key** | **String** | 1Password user secret key to connect to the API | [optional] |
|
10
10
|
| **_1password_url** | **String** | 1Password api container url | [optional] |
|
11
11
|
| **_1password_vaults** | **Array<String>** | 1Password list of vault to get the items from | [optional] |
|
12
|
-
| **ad_auto_rotate_boolean** | **Boolean** | | [optional] |
|
13
|
-
| **ad_discover_local_users_boolean** | **Boolean** | | [optional] |
|
14
|
-
| **ad_local_users_ignore_list** | **Hash<String, Boolean>** | | [optional] |
|
15
|
-
| **ad_sra_enable_rdp_boolean** | **Boolean** | | [optional] |
|
16
12
|
| **ad_auto_rotate** | **String** | Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration) | [optional] |
|
17
13
|
| **ad_computer_base_dn** | **String** | Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration) | [optional] |
|
18
14
|
| **ad_discover_local_users** | **String** | Enable/Disable discovery of local users from each domain server and migrate them as SSH Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) | [optional] |
|
@@ -68,10 +64,6 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
68
64
|
_1password_secret_key: null,
|
69
65
|
_1password_url: null,
|
70
66
|
_1password_vaults: null,
|
71
|
-
ad_auto_rotate_boolean: null,
|
72
|
-
ad_discover_local_users_boolean: null,
|
73
|
-
ad_local_users_ignore_list: null,
|
74
|
-
ad_sra_enable_rdp_boolean: null,
|
75
67
|
ad_auto_rotate: null,
|
76
68
|
ad_computer_base_dn: null,
|
77
69
|
ad_discover_local_users: null,
|
@@ -9,10 +9,6 @@
|
|
9
9
|
| **_1password_secret_key** | **String** | 1Password user secret key to connect to the API | [optional] |
|
10
10
|
| **_1password_url** | **String** | 1Password api container url | [optional] |
|
11
11
|
| **_1password_vaults** | **Array<String>** | 1Password list of vault to get the items from | [optional] |
|
12
|
-
| **ad_auto_rotate_boolean** | **Boolean** | | [optional] |
|
13
|
-
| **ad_discover_local_users_boolean** | **Boolean** | | [optional] |
|
14
|
-
| **ad_local_users_ignore_list** | **Hash<String, Boolean>** | | [optional] |
|
15
|
-
| **ad_sra_enable_rdp_boolean** | **Boolean** | | [optional] |
|
16
12
|
| **ad_auto_rotate** | **String** | Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration) | [optional] |
|
17
13
|
| **ad_computer_base_dn** | **String** | Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration) | [optional] |
|
18
14
|
| **ad_discover_local_users** | **String** | Enable/Disable discovery of local users from each domain server and migrate them as SSH Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) | [optional] |
|
@@ -69,10 +65,6 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
69
65
|
_1password_secret_key: null,
|
70
66
|
_1password_url: null,
|
71
67
|
_1password_vaults: null,
|
72
|
-
ad_auto_rotate_boolean: null,
|
73
|
-
ad_discover_local_users_boolean: null,
|
74
|
-
ad_local_users_ignore_list: null,
|
75
|
-
ad_sra_enable_rdp_boolean: null,
|
76
68
|
ad_auto_rotate: null,
|
77
69
|
ad_computer_base_dn: null,
|
78
70
|
ad_discover_local_users: null,
|
data/docs/GetSecretValue.md
CHANGED
@@ -4,8 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **accessibility** | **String** | for personal password manager | [optional] |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
9
8
|
| **ignore_cache** | **String** | Ignore Cache Retrieve the Secret value without checking the Gateway's cache. This flag is only relevant when using the RestAPI | [optional] |
|
10
9
|
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
11
10
|
| **names** | **Array<String>** | Secret name | |
|
@@ -20,7 +19,6 @@
|
|
20
19
|
require 'akeyless'
|
21
20
|
|
22
21
|
instance = Akeyless::GetSecretValue.new(
|
23
|
-
ignore_cache_boolean: null,
|
24
22
|
accessibility: null,
|
25
23
|
ignore_cache: null,
|
26
24
|
json: null,
|
data/docs/ListItems.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accessibility** | **String** | for personal password manager | [optional] |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
8
|
| **filter** | **String** | Filter by item name or part of it | [optional] |
|
9
9
|
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
10
10
|
| **minimal_view** | **Boolean** | | [optional] |
|
data/docs/MigrationGeneral.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **prefix** | **String** | | [optional] |
|
11
11
|
| **protection_key** | **String** | | [optional] |
|
12
12
|
| **status** | **String** | | [optional] |
|
13
|
+
| **type** | **String** | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = Akeyless::MigrationGeneral.new(
|
|
22
23
|
new_name: null,
|
23
24
|
prefix: null,
|
24
25
|
protection_key: null,
|
25
|
-
status: null
|
26
|
+
status: null,
|
27
|
+
type: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
data/docs/OIDCAccessRules.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **allowed_redirect_uris** | **Array<String>** | Allowed redirect URIs after the authentication | [optional] |
|
8
|
+
| **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's Application | [optional] |
|
8
9
|
| **bound_claims** | [**Array<OIDCCustomClaim>**](OIDCCustomClaim.md) | The claims that login is restricted to. | [optional] |
|
9
10
|
| **client_id** | **String** | Client ID | [optional] |
|
10
11
|
| **client_secret** | **String** | Client Secret | [optional] |
|
@@ -21,6 +22,7 @@ require 'akeyless'
|
|
21
22
|
|
22
23
|
instance = Akeyless::OIDCAccessRules.new(
|
23
24
|
allowed_redirect_uris: null,
|
25
|
+
audience: null,
|
24
26
|
bound_claims: null,
|
25
27
|
client_id: null,
|
26
28
|
client_secret: null,
|
data/docs/ReverseRBACClient.md
CHANGED
@@ -4,7 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **allowed_ops** | **Array<String>** | | [optional] |
|
8
7
|
| **assocs** | [**Array<AuthMethodRoleAssociation>**](AuthMethodRoleAssociation.md) | | [optional] |
|
9
8
|
| **auth_method_name** | **String** | | [optional] |
|
10
9
|
|
@@ -14,7 +13,6 @@
|
|
14
13
|
require 'akeyless'
|
15
14
|
|
16
15
|
instance = Akeyless::ReverseRBACClient.new(
|
17
|
-
allowed_ops: null,
|
18
16
|
assocs: null,
|
19
17
|
auth_method_name: null
|
20
18
|
)
|
data/docs/RotateSecret.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
8
|
-
| **name** | **String** | Rotated Secret
|
8
|
+
| **name** | **String** | Secret name (Rotated Secret or Custom Dynamic Secret) | |
|
9
9
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
10
10
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
11
11
|
|
data/docs/ShareItem.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# Akeyless::ShareItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
|
+
| **action** | **String** | Action to be performed on the item [start/stop/describe] | |
|
9
|
+
| **emails** | **Array<String>** | For Password Management use, reflect the website context | [optional] |
|
10
|
+
| **item_name** | **String** | Item name | |
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
12
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
13
|
+
| **ttl** | **Integer** | TTL of the Availability of the shared secret in seconds | [optional] |
|
14
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
15
|
+
| **view_once** | **Boolean** | ViewOnlyOnce Shared secrets can only be viewed once [true/false] | [optional][default to false] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'akeyless'
|
21
|
+
|
22
|
+
instance = Akeyless::ShareItem.new(
|
23
|
+
accessibility: null,
|
24
|
+
action: null,
|
25
|
+
emails: null,
|
26
|
+
item_name: null,
|
27
|
+
json: null,
|
28
|
+
token: null,
|
29
|
+
ttl: null,
|
30
|
+
uid_token: null,
|
31
|
+
view_once: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/SmInfo.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **tier** | **String** |
|
7
|
+
| **sla** | **String** | | [optional] |
|
8
|
+
| **tier** | **String** | Tier represents a level of extensibility the account will have, defined by various limits for different resources of Akeyless e.g - A StarterTier may have a limit of 3 Client resources and 50 Secret resources | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -13,7 +13,7 @@
|
|
13
13
|
require 'akeyless'
|
14
14
|
|
15
15
|
instance = Akeyless::SmInfo.new(
|
16
|
-
|
16
|
+
sla: null,
|
17
17
|
tier: null
|
18
18
|
)
|
19
19
|
```
|
data/docs/SraInfo.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **tier** | **String** |
|
7
|
+
| **sla** | **String** | | [optional] |
|
8
|
+
| **tier** | **String** | Tier represents a level of extensibility the account will have, defined by various limits for different resources of Akeyless e.g - A StarterTier may have a limit of 3 Client resources and 50 Secret resources | [optional] |
|
9
9
|
| **user_type** | **String** | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
@@ -14,7 +14,7 @@
|
|
14
14
|
require 'akeyless'
|
15
15
|
|
16
16
|
instance = Akeyless::SraInfo.new(
|
17
|
-
|
17
|
+
sla: null,
|
18
18
|
tier: null,
|
19
19
|
user_type: null
|
20
20
|
)
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **access_expires** | **Integer** | Access expiration date in Unix timestamp (select 0 for access without expiry date) | [optional][default to 0] |
|
8
8
|
| **allowed_redirect_uri** | **Array<String>** | Allowed redirect URIs after the authentication | [optional] |
|
9
|
+
| **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's Application | [optional] |
|
9
10
|
| **bound_ips** | **Array<String>** | A CIDR whitelist with the IPs that the access is restricted to | [optional] |
|
10
11
|
| **client_id** | **String** | Client ID | [optional] |
|
11
12
|
| **client_secret** | **String** | Client Secret | [optional] |
|
@@ -30,6 +31,7 @@ require 'akeyless'
|
|
30
31
|
instance = Akeyless::UpdateAuthMethodOIDC.new(
|
31
32
|
access_expires: null,
|
32
33
|
allowed_redirect_uri: null,
|
34
|
+
audience: null,
|
33
35
|
bound_ips: null,
|
34
36
|
client_id: null,
|
35
37
|
client_secret: null,
|
data/docs/UpdateItem.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accessibility** | **String** | for personal password manager | [optional] |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
8
|
| **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
|
9
9
|
| **cert_file_data** | **String** | PEM Certificate in a Base64 format. Used for updating RSA keys' certificates. | [optional] |
|
10
10
|
| **delete_protection** | **String** | | [optional] |
|
data/docs/UpdateSecretVal.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accessibility** | **String** | for personal password manager | [optional] |
|
7
|
+
| **accessibility** | **String** | for personal password manager | [optional][default to 'regular'] |
|
8
8
|
| **json** | **Boolean** | Set output format to JSON | [optional] |
|
9
9
|
| **keep_prev_version** | **String** | | [optional] |
|
10
10
|
| **key** | **String** | The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
data/docs/V2Api.md
CHANGED
@@ -66,6 +66,7 @@ All URIs are relative to *https://api.akeyless.io*
|
|
66
66
|
| [**detokenize**](V2Api.md#detokenize) | **POST** /detokenize | |
|
67
67
|
| [**encrypt**](V2Api.md#encrypt) | **POST** /encrypt | |
|
68
68
|
| [**encrypt_with_classic_key**](V2Api.md#encrypt_with_classic_key) | **POST** /encrypt-with-classic-key | |
|
69
|
+
| [**export_classic_key**](V2Api.md#export_classic_key) | **GET** /export-classic-key | |
|
69
70
|
| [**gateway_add_allowed_management_access**](V2Api.md#gateway_add_allowed_management_access) | **POST** /gateway-add-allow-management-access | |
|
70
71
|
| [**gateway_create_k8_s_auth_config**](V2Api.md#gateway_create_k8_s_auth_config) | **POST** /gateway-create-k8s-auth-config | |
|
71
72
|
| [**gateway_create_migration**](V2Api.md#gateway_create_migration) | **POST** /gateway-create-migration | |
|
@@ -182,6 +183,7 @@ All URIs are relative to *https://api.akeyless.io*
|
|
182
183
|
| [**rotate_secret**](V2Api.md#rotate_secret) | **POST** /gateway-rotate-secret | |
|
183
184
|
| [**set_item_state**](V2Api.md#set_item_state) | **POST** /set-item-state | |
|
184
185
|
| [**set_role_rule**](V2Api.md#set_role_rule) | **POST** /set-role-rule | |
|
186
|
+
| [**share_item**](V2Api.md#share_item) | **POST** /share-item | |
|
185
187
|
| [**sign_jwt_with_classic_key**](V2Api.md#sign_jwt_with_classic_key) | **POST** /sign-jwt-with-classic-key | |
|
186
188
|
| [**sign_pkcs1**](V2Api.md#sign_pkcs1) | **POST** /sign-pkcs1 | |
|
187
189
|
| [**sign_pki_cert_with_classic_key**](V2Api.md#sign_pki_cert_with_classic_key) | **POST** /sign-pki-cert-with-classic-key | |
|
@@ -4087,6 +4089,68 @@ No authorization required
|
|
4087
4089
|
- **Accept**: application/json
|
4088
4090
|
|
4089
4091
|
|
4092
|
+
## export_classic_key
|
4093
|
+
|
4094
|
+
> <ExportClassicKeyOutput> export_classic_key(body)
|
4095
|
+
|
4096
|
+
|
4097
|
+
|
4098
|
+
### Examples
|
4099
|
+
|
4100
|
+
```ruby
|
4101
|
+
require 'time'
|
4102
|
+
require 'akeyless'
|
4103
|
+
|
4104
|
+
api_instance = Akeyless::V2Api.new
|
4105
|
+
body = Akeyless::ExportClassicKey.new({name: 'name_example'}) # ExportClassicKey |
|
4106
|
+
|
4107
|
+
begin
|
4108
|
+
|
4109
|
+
result = api_instance.export_classic_key(body)
|
4110
|
+
p result
|
4111
|
+
rescue Akeyless::ApiError => e
|
4112
|
+
puts "Error when calling V2Api->export_classic_key: #{e}"
|
4113
|
+
end
|
4114
|
+
```
|
4115
|
+
|
4116
|
+
#### Using the export_classic_key_with_http_info variant
|
4117
|
+
|
4118
|
+
This returns an Array which contains the response data, status code and headers.
|
4119
|
+
|
4120
|
+
> <Array(<ExportClassicKeyOutput>, Integer, Hash)> export_classic_key_with_http_info(body)
|
4121
|
+
|
4122
|
+
```ruby
|
4123
|
+
begin
|
4124
|
+
|
4125
|
+
data, status_code, headers = api_instance.export_classic_key_with_http_info(body)
|
4126
|
+
p status_code # => 2xx
|
4127
|
+
p headers # => { ... }
|
4128
|
+
p data # => <ExportClassicKeyOutput>
|
4129
|
+
rescue Akeyless::ApiError => e
|
4130
|
+
puts "Error when calling V2Api->export_classic_key_with_http_info: #{e}"
|
4131
|
+
end
|
4132
|
+
```
|
4133
|
+
|
4134
|
+
### Parameters
|
4135
|
+
|
4136
|
+
| Name | Type | Description | Notes |
|
4137
|
+
| ---- | ---- | ----------- | ----- |
|
4138
|
+
| **body** | [**ExportClassicKey**](ExportClassicKey.md) | | |
|
4139
|
+
|
4140
|
+
### Return type
|
4141
|
+
|
4142
|
+
[**ExportClassicKeyOutput**](ExportClassicKeyOutput.md)
|
4143
|
+
|
4144
|
+
### Authorization
|
4145
|
+
|
4146
|
+
No authorization required
|
4147
|
+
|
4148
|
+
### HTTP request headers
|
4149
|
+
|
4150
|
+
- **Content-Type**: application/json
|
4151
|
+
- **Accept**: application/json
|
4152
|
+
|
4153
|
+
|
4090
4154
|
## gateway_add_allowed_management_access
|
4091
4155
|
|
4092
4156
|
> Object gateway_add_allowed_management_access(body)
|
@@ -11305,6 +11369,67 @@ No authorization required
|
|
11305
11369
|
- **Accept**: application/json
|
11306
11370
|
|
11307
11371
|
|
11372
|
+
## share_item
|
11373
|
+
|
11374
|
+
> share_item(body)
|
11375
|
+
|
11376
|
+
|
11377
|
+
|
11378
|
+
### Examples
|
11379
|
+
|
11380
|
+
```ruby
|
11381
|
+
require 'time'
|
11382
|
+
require 'akeyless'
|
11383
|
+
|
11384
|
+
api_instance = Akeyless::V2Api.new
|
11385
|
+
body = Akeyless::ShareItem.new({action: 'action_example', item_name: 'item_name_example'}) # ShareItem |
|
11386
|
+
|
11387
|
+
begin
|
11388
|
+
|
11389
|
+
api_instance.share_item(body)
|
11390
|
+
rescue Akeyless::ApiError => e
|
11391
|
+
puts "Error when calling V2Api->share_item: #{e}"
|
11392
|
+
end
|
11393
|
+
```
|
11394
|
+
|
11395
|
+
#### Using the share_item_with_http_info variant
|
11396
|
+
|
11397
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
11398
|
+
|
11399
|
+
> <Array(nil, Integer, Hash)> share_item_with_http_info(body)
|
11400
|
+
|
11401
|
+
```ruby
|
11402
|
+
begin
|
11403
|
+
|
11404
|
+
data, status_code, headers = api_instance.share_item_with_http_info(body)
|
11405
|
+
p status_code # => 2xx
|
11406
|
+
p headers # => { ... }
|
11407
|
+
p data # => nil
|
11408
|
+
rescue Akeyless::ApiError => e
|
11409
|
+
puts "Error when calling V2Api->share_item_with_http_info: #{e}"
|
11410
|
+
end
|
11411
|
+
```
|
11412
|
+
|
11413
|
+
### Parameters
|
11414
|
+
|
11415
|
+
| Name | Type | Description | Notes |
|
11416
|
+
| ---- | ---- | ----------- | ----- |
|
11417
|
+
| **body** | [**ShareItem**](ShareItem.md) | | |
|
11418
|
+
|
11419
|
+
### Return type
|
11420
|
+
|
11421
|
+
nil (empty response body)
|
11422
|
+
|
11423
|
+
### Authorization
|
11424
|
+
|
11425
|
+
No authorization required
|
11426
|
+
|
11427
|
+
### HTTP request headers
|
11428
|
+
|
11429
|
+
- **Content-Type**: application/json
|
11430
|
+
- **Accept**: application/json
|
11431
|
+
|
11432
|
+
|
11308
11433
|
## sign_jwt_with_classic_key
|
11309
11434
|
|
11310
11435
|
> <SignJWTOutput> sign_jwt_with_classic_key(body)
|
@@ -8,7 +8,7 @@
|
|
8
8
|
| **key_name** | **String** | | [optional] |
|
9
9
|
| **regexp_tokenizer_info** | [**RegexpTokenizerInfo**](RegexpTokenizerInfo.md) | | [optional] |
|
10
10
|
| **template_type** | **String** | | [optional] |
|
11
|
-
| **tweak** | **
|
11
|
+
| **tweak** | **String** | Tweak used in the case of internal tweak type | [optional] |
|
12
12
|
| **tweak_type** | **String** | | [optional] |
|
13
13
|
|
14
14
|
## Example
|