akeyless 5.0.28 → 5.0.30
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 +49 -1
- data/docs/AccountGeneralSettings.md +4 -0
- data/docs/AnthropicTargetDetails.md +20 -0
- data/docs/AuthMethod.md +3 -1
- data/docs/AuthMethodAccessInfo.md +2 -0
- data/docs/AuthMethodCreateSAML.md +3 -1
- data/docs/AuthMethodCreateUniversalIdentity.md +2 -0
- data/docs/AuthMethodUpdateSAML.md +3 -1
- data/docs/AuthMethodUpdateUniversalIdentity.md +2 -0
- data/docs/BedrockTargetDetails.md +20 -0
- data/docs/CreateAuthMethodSAML.md +3 -1
- data/docs/CreateAuthMethodUniversalIdentity.md +2 -0
- data/docs/CreateDBTarget.md +2 -0
- data/docs/CreateMcpSecretBearerToken.md +46 -0
- data/docs/CreateMcpSecretOAuthAuthCode.md +56 -0
- data/docs/CreateMcpSecretOAuthClientCreds.md +52 -0
- data/docs/CreatePKICertIssuer.md +1 -1
- data/docs/CustomDnsTargetDetails.md +20 -0
- data/docs/DSProducerDetails.md +2 -0
- data/docs/DbTargetDetails.md +2 -0
- data/docs/EmailCustomization.md +28 -0
- data/docs/EmailCustomizationAccountInformation.md +24 -0
- data/docs/EmailCustomizationAccountInformationValues.md +24 -0
- data/docs/EsmGetSecretOutput.md +4 -0
- data/docs/FileDownloadInstructions.md +20 -0
- data/docs/FileInfo.md +50 -0
- data/docs/GatewayCreateMigration.md +2 -0
- data/docs/GatewayUpdateMigration.md +2 -0
- data/docs/GetKubeExecCreds.md +1 -1
- data/docs/GetPKICertificate.md +1 -1
- data/docs/GrokTargetDetails.md +22 -0
- data/docs/HashiPayload.md +2 -0
- data/docs/Item.md +2 -0
- data/docs/KeycloakTargetDetails.md +24 -0
- data/docs/OktaTargetDetails.md +20 -0
- data/docs/RuntimeAuthorityCommand.md +4 -0
- data/docs/SAMLAccessRules.md +3 -1
- data/docs/StaticSecretDetailsInfo.md +2 -0
- data/docs/TargetCreateAnthropic.md +36 -0
- data/docs/TargetCreateBedrock.md +36 -0
- data/docs/TargetCreateCustomDns.md +36 -0
- data/docs/TargetCreateDB.md +2 -0
- data/docs/TargetCreateGrok.md +38 -0
- data/docs/TargetCreateKeycloak.md +40 -0
- data/docs/TargetCreateOkta.md +36 -0
- data/docs/TargetTypeDetailsInput.md +12 -0
- data/docs/TargetUpdateAnthropic.md +42 -0
- data/docs/TargetUpdateBedrock.md +42 -0
- data/docs/TargetUpdateCustomDns.md +40 -0
- data/docs/TargetUpdateDB.md +2 -0
- data/docs/TargetUpdateGrok.md +44 -0
- data/docs/TargetUpdateKeycloak.md +44 -0
- data/docs/TargetUpdateOkta.md +40 -0
- data/docs/UidExpirationEvent.md +18 -0
- data/docs/UpdateAuthMethodSAML.md +3 -1
- data/docs/UpdateAuthMethodUniversalIdentity.md +2 -0
- data/docs/UpdateDBTarget.md +2 -0
- data/docs/UpdateMcpSecretBearerToken.md +40 -0
- data/docs/UpdateMcpSecretOAuthAuthCode.md +50 -0
- data/docs/UpdateMcpSecretOAuthClientCreds.md +46 -0
- data/docs/UpdatePKICertIssuer.md +1 -1
- data/docs/UscGetSecretOutput.md +4 -0
- data/docs/V2Api.md +1134 -0
- data/lib/akeyless/api/v2_api.rb +1249 -97
- data/lib/akeyless/models/account_general_settings.rb +20 -1
- data/lib/akeyless/models/anthropic_target_details.rb +224 -0
- data/lib/akeyless/models/auth_method.rb +15 -4
- data/lib/akeyless/models/auth_method_access_info.rb +13 -1
- data/lib/akeyless/models/auth_method_create_saml.rb +14 -4
- data/lib/akeyless/models/auth_method_create_universal_identity.rb +13 -1
- data/lib/akeyless/models/auth_method_update_saml.rb +14 -4
- data/lib/akeyless/models/auth_method_update_universal_identity.rb +13 -1
- data/lib/akeyless/models/bedrock_target_details.rb +224 -0
- data/lib/akeyless/models/create_auth_method_saml.rb +14 -4
- data/lib/akeyless/models/create_auth_method_universal_identity.rb +13 -1
- data/lib/akeyless/models/create_db_target.rb +11 -1
- data/lib/akeyless/models/create_mcp_secret_bearer_token.rb +371 -0
- data/lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb +423 -0
- data/lib/akeyless/models/create_mcp_secret_o_auth_client_creds.rb +403 -0
- data/lib/akeyless/models/create_pki_cert_issuer.rb +1 -1
- data/lib/akeyless/models/custom_dns_target_details.rb +225 -0
- data/lib/akeyless/models/db_target_details.rb +11 -1
- data/lib/akeyless/models/ds_producer_details.rb +11 -1
- data/lib/akeyless/models/email_customization.rb +259 -0
- data/lib/akeyless/models/email_customization_account_information.rb +242 -0
- data/lib/akeyless/models/email_customization_account_information_values.rb +241 -0
- data/lib/akeyless/models/esm_get_secret_output.rb +19 -1
- data/lib/akeyless/models/file_download_instructions.rb +223 -0
- data/lib/akeyless/models/file_info.rb +358 -0
- data/lib/akeyless/models/gateway_create_migration.rb +11 -1
- data/lib/akeyless/models/gateway_update_migration.rb +11 -1
- data/lib/akeyless/models/get_kube_exec_creds.rb +1 -1
- data/lib/akeyless/models/get_pki_certificate.rb +1 -1
- data/lib/akeyless/models/grok_target_details.rb +234 -0
- data/lib/akeyless/models/hashi_payload.rb +10 -1
- data/lib/akeyless/models/item.rb +10 -1
- data/lib/akeyless/models/keycloak_target_details.rb +242 -0
- data/lib/akeyless/models/okta_target_details.rb +224 -0
- data/lib/akeyless/models/runtime_authority_command.rb +21 -1
- data/lib/akeyless/models/saml_access_rules.rb +14 -4
- data/lib/akeyless/models/static_secret_details_info.rb +10 -1
- data/lib/akeyless/models/target_create_anthropic.rb +317 -0
- data/lib/akeyless/models/target_create_bedrock.rb +317 -0
- data/lib/akeyless/models/target_create_custom_dns.rb +330 -0
- data/lib/akeyless/models/target_create_db.rb +11 -1
- data/lib/akeyless/models/target_create_grok.rb +327 -0
- data/lib/akeyless/models/target_create_keycloak.rb +334 -0
- data/lib/akeyless/models/target_create_okta.rb +314 -0
- data/lib/akeyless/models/target_type_details_input.rb +55 -1
- data/lib/akeyless/models/target_update_anthropic.rb +351 -0
- data/lib/akeyless/models/target_update_bedrock.rb +351 -0
- data/lib/akeyless/models/target_update_custom_dns.rb +350 -0
- data/lib/akeyless/models/target_update_db.rb +11 -1
- data/lib/akeyless/models/target_update_grok.rb +361 -0
- data/lib/akeyless/models/target_update_keycloak.rb +354 -0
- data/lib/akeyless/models/target_update_okta.rb +334 -0
- data/lib/akeyless/models/uid_expiration_event.rb +214 -0
- data/lib/akeyless/models/update_auth_method_saml.rb +14 -4
- data/lib/akeyless/models/update_auth_method_universal_identity.rb +13 -1
- data/lib/akeyless/models/update_db_target.rb +11 -1
- data/lib/akeyless/models/update_mcp_secret_bearer_token.rb +338 -0
- data/lib/akeyless/models/update_mcp_secret_o_auth_auth_code.rb +390 -0
- data/lib/akeyless/models/update_mcp_secret_o_auth_client_creds.rb +370 -0
- data/lib/akeyless/models/update_pki_cert_issuer.rb +1 -1
- data/lib/akeyless/models/usc_get_secret_output.rb +19 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +30 -0
- data/spec/models/anthropic_target_details_spec.rb +42 -0
- data/spec/models/bedrock_target_details_spec.rb +42 -0
- data/spec/models/create_mcp_secret_bearer_token_spec.rb +120 -0
- data/spec/models/create_mcp_secret_o_auth_auth_code_spec.rb +150 -0
- data/spec/models/create_mcp_secret_o_auth_client_creds_spec.rb +138 -0
- data/spec/models/custom_dns_target_details_spec.rb +42 -0
- data/spec/models/email_customization_account_information_spec.rb +54 -0
- data/spec/models/email_customization_account_information_values_spec.rb +54 -0
- data/spec/models/email_customization_spec.rb +66 -0
- data/spec/models/file_download_instructions_spec.rb +42 -0
- data/spec/models/file_info_spec.rb +132 -0
- data/spec/models/grok_target_details_spec.rb +48 -0
- data/spec/models/keycloak_target_details_spec.rb +54 -0
- data/spec/models/okta_target_details_spec.rb +42 -0
- data/spec/models/target_create_anthropic_spec.rb +90 -0
- data/spec/models/target_create_bedrock_spec.rb +90 -0
- data/spec/models/target_create_custom_dns_spec.rb +90 -0
- data/spec/models/target_create_grok_spec.rb +96 -0
- data/spec/models/target_create_keycloak_spec.rb +102 -0
- data/spec/models/target_create_okta_spec.rb +90 -0
- data/spec/models/target_update_anthropic_spec.rb +108 -0
- data/spec/models/target_update_bedrock_spec.rb +108 -0
- data/spec/models/target_update_custom_dns_spec.rb +102 -0
- data/spec/models/target_update_grok_spec.rb +114 -0
- data/spec/models/target_update_keycloak_spec.rb +114 -0
- data/spec/models/target_update_okta_spec.rb +102 -0
- data/spec/models/uid_expiration_event_spec.rb +36 -0
- data/spec/models/update_mcp_secret_bearer_token_spec.rb +102 -0
- data/spec/models/update_mcp_secret_o_auth_auth_code_spec.rb +132 -0
- data/spec/models/update_mcp_secret_o_auth_client_creds_spec.rb +120 -0
- metadata +1295 -1175
data/docs/CreatePKICertIssuer.md
CHANGED
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
| **street_address** | **String** | A comma-separated list of street addresses that will be set in the issued certificate | [optional] |
|
|
52
52
|
| **tag** | **Array<String>** | List of the tags attached to this key | [optional] |
|
|
53
53
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
54
|
-
| **ttl** | **String** | The maximum requested Time To Live for issued certificates, in seconds. In case of Public CA, this is based on the CA target's supported maximum TTLs | |
|
|
54
|
+
| **ttl** | **String** | The maximum requested Time To Live for issued certificates, in seconds. In case of Public CA, this is based on the CA target's supported maximum TTLs. Not supported for Let's Encrypt, which always uses the CA default lifetime (about 90 days). | |
|
|
55
55
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
56
56
|
|
|
57
57
|
## Example
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::CustomDnsTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **parameters** | **Hash<String, String>** | | [optional] |
|
|
8
|
+
| **provider_type** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::CustomDnsTargetDetails.new(
|
|
16
|
+
parameters: null,
|
|
17
|
+
provider_type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/DSProducerDetails.md
CHANGED
|
@@ -245,6 +245,7 @@
|
|
|
245
245
|
| **sf_warehouse_name** | **String** | | [optional] |
|
|
246
246
|
| **should_stop** | **String** | TODO delete this after migration | [optional] |
|
|
247
247
|
| **signing_algorithm** | **String** | | [optional] |
|
|
248
|
+
| **skip_server_name_validation** | **String** | (Optional) SkipServerNameValidation disables server name verification while still validating the certificate chain. Postgres treats empty as legacy \"skip hostname validation\"; MySQL treats empty as false. | [optional] |
|
|
248
249
|
| **ssl_connection_certificate** | **String** | (Optional) SSLConnectionCertificate defines the certificate for SSL connection. Must be base64 certificate loaded by UI using file loader field | [optional] |
|
|
249
250
|
| **ssl_connection_mode** | **Boolean** | (Optional) SSLConnectionMode defines if SSL mode will be used to connect to DB | [optional] |
|
|
250
251
|
| **subject_dn** | **String** | | [optional] |
|
|
@@ -524,6 +525,7 @@ instance = Akeyless::DSProducerDetails.new(
|
|
|
524
525
|
sf_warehouse_name: null,
|
|
525
526
|
should_stop: null,
|
|
526
527
|
signing_algorithm: null,
|
|
528
|
+
skip_server_name_validation: null,
|
|
527
529
|
ssl_connection_certificate: null,
|
|
528
530
|
ssl_connection_mode: null,
|
|
529
531
|
subject_dn: null,
|
data/docs/DbTargetDetails.md
CHANGED
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
| **enable_mtls** | **Boolean** | (Optional) EnableMTLS defines if mutual TLS will be used to connect to DB | [optional] |
|
|
26
26
|
| **oracle_wallet_details** | [**WalletDetails**](WalletDetails.md) | | [optional] |
|
|
27
27
|
| **sf_account** | **String** | | [optional] |
|
|
28
|
+
| **skip_server_name_validation** | **String** | (Optional) SkipServerNameValidation disables server name verification while still validating the certificate chain. Postgres treats empty as legacy \"skip hostname validation\"; MySQL treats empty as false. | [optional] |
|
|
28
29
|
| **ssl_connection_certificate** | **String** | (Optional) SSLConnectionCertificate defines the certificate for SSL connection. Must be base64 certificate loaded by UI using file loader field | [optional] |
|
|
29
30
|
| **ssl_connection_mode** | **Boolean** | (Optional) SSLConnectionMode defines if SSL mode will be used to connect to DB | [optional] |
|
|
30
31
|
|
|
@@ -55,6 +56,7 @@ instance = Akeyless::DbTargetDetails.new(
|
|
|
55
56
|
enable_mtls: null,
|
|
56
57
|
oracle_wallet_details: null,
|
|
57
58
|
sf_account: null,
|
|
59
|
+
skip_server_name_validation: null,
|
|
58
60
|
ssl_connection_certificate: null,
|
|
59
61
|
ssl_connection_mode: null
|
|
60
62
|
)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Akeyless::EmailCustomization
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_information_fields** | [**EmailCustomizationAccountInformation**](EmailCustomizationAccountInformation.md) | | [optional] |
|
|
8
|
+
| **account_information_values** | [**EmailCustomizationAccountInformationValues**](EmailCustomizationAccountInformationValues.md) | | [optional] |
|
|
9
|
+
| **footer_html** | **String** | | [optional] |
|
|
10
|
+
| **sender_name** | **String** | | [optional] |
|
|
11
|
+
| **show_background_image** | **Boolean** | | [optional] |
|
|
12
|
+
| **subject** | **String** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'akeyless'
|
|
18
|
+
|
|
19
|
+
instance = Akeyless::EmailCustomization.new(
|
|
20
|
+
account_information_fields: null,
|
|
21
|
+
account_information_values: null,
|
|
22
|
+
footer_html: null,
|
|
23
|
+
sender_name: null,
|
|
24
|
+
show_background_image: null,
|
|
25
|
+
subject: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Akeyless::EmailCustomizationAccountInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **Boolean** | | [optional] |
|
|
8
|
+
| **alias_name** | **Boolean** | | [optional] |
|
|
9
|
+
| **company_name** | **Boolean** | | [optional] |
|
|
10
|
+
| **tenant_name** | **Boolean** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'akeyless'
|
|
16
|
+
|
|
17
|
+
instance = Akeyless::EmailCustomizationAccountInformation.new(
|
|
18
|
+
account_id: null,
|
|
19
|
+
alias_name: null,
|
|
20
|
+
company_name: null,
|
|
21
|
+
tenant_name: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Akeyless::EmailCustomizationAccountInformationValues
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | | [optional] |
|
|
8
|
+
| **alias_name** | **String** | | [optional] |
|
|
9
|
+
| **company_name** | **String** | | [optional] |
|
|
10
|
+
| **tenant_name** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'akeyless'
|
|
16
|
+
|
|
17
|
+
instance = Akeyless::EmailCustomizationAccountInformationValues.new(
|
|
18
|
+
account_id: null,
|
|
19
|
+
alias_name: null,
|
|
20
|
+
company_name: null,
|
|
21
|
+
tenant_name: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/EsmGetSecretOutput.md
CHANGED
|
@@ -4,8 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **activation_date** | **Time** | | [optional] |
|
|
7
8
|
| **binary_value** | **Boolean** | | [optional] |
|
|
8
9
|
| **encryption_key** | **String** | | [optional] |
|
|
10
|
+
| **expiration** | **Time** | | [optional] |
|
|
9
11
|
| **id** | **String** | | [optional] |
|
|
10
12
|
| **metadata** | **Object** | | [optional] |
|
|
11
13
|
| **name** | **String** | | [optional] |
|
|
@@ -20,8 +22,10 @@
|
|
|
20
22
|
require 'akeyless'
|
|
21
23
|
|
|
22
24
|
instance = Akeyless::EsmGetSecretOutput.new(
|
|
25
|
+
activation_date: null,
|
|
23
26
|
binary_value: null,
|
|
24
27
|
encryption_key: null,
|
|
28
|
+
expiration: null,
|
|
25
29
|
id: null,
|
|
26
30
|
metadata: null,
|
|
27
31
|
name: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::FileDownloadInstructions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **expires_at** | **Time** | | [optional] |
|
|
8
|
+
| **url** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::FileDownloadInstructions.new(
|
|
16
|
+
expires_at: null,
|
|
17
|
+
url: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/FileInfo.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Akeyless::FileInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **blob_storage_key** | **String** | | [optional] |
|
|
8
|
+
| **client_file_sha256** | **String** | | [optional] |
|
|
9
|
+
| **content_type** | **String** | | [optional] |
|
|
10
|
+
| **derivation_data** | **String** | | [optional] |
|
|
11
|
+
| **encrypted_blob_sha256** | **String** | | [optional] |
|
|
12
|
+
| **encrypted_size_bytes** | **Integer** | | [optional] |
|
|
13
|
+
| **etag_at_complete** | **String** | | [optional] |
|
|
14
|
+
| **extension** | **String** | | [optional] |
|
|
15
|
+
| **file_id** | **String** | | [optional] |
|
|
16
|
+
| **filename** | **String** | | [optional] |
|
|
17
|
+
| **plain_size_bytes** | **Integer** | | [optional] |
|
|
18
|
+
| **previous_active_file_info** | [**FileInfo**](FileInfo.md) | | [optional] |
|
|
19
|
+
| **previous_blob_storage_key** | **String** | | [optional] |
|
|
20
|
+
| **protection_key_name** | **String** | | [optional] |
|
|
21
|
+
| **protection_key_version** | **Integer** | | [optional] |
|
|
22
|
+
| **status** | **String** | | [optional] |
|
|
23
|
+
| **transaction_owner** | **String** | | [optional] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'akeyless'
|
|
29
|
+
|
|
30
|
+
instance = Akeyless::FileInfo.new(
|
|
31
|
+
blob_storage_key: null,
|
|
32
|
+
client_file_sha256: null,
|
|
33
|
+
content_type: null,
|
|
34
|
+
derivation_data: null,
|
|
35
|
+
encrypted_blob_sha256: null,
|
|
36
|
+
encrypted_size_bytes: null,
|
|
37
|
+
etag_at_complete: null,
|
|
38
|
+
extension: null,
|
|
39
|
+
file_id: null,
|
|
40
|
+
filename: null,
|
|
41
|
+
plain_size_bytes: null,
|
|
42
|
+
previous_active_file_info: null,
|
|
43
|
+
previous_blob_storage_key: null,
|
|
44
|
+
protection_key_name: null,
|
|
45
|
+
protection_key_version: null,
|
|
46
|
+
status: null,
|
|
47
|
+
transaction_owner: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -74,6 +74,7 @@
|
|
|
74
74
|
| **si_users_ignore** | **String** | Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration) | [optional] |
|
|
75
75
|
| **si_users_path_template** | **String** | Path location template for migrating users as Rotated Secrets e.g.: .../Users/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Server Inventory migration) | |
|
|
76
76
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
77
|
+
| **target_name** | **String** | Name of existing target to use to create the migration | [optional] |
|
|
77
78
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
78
79
|
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/conjur/active_directory/server_inventory/certificate) | [optional] |
|
|
79
80
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
@@ -156,6 +157,7 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
156
157
|
si_users_ignore: null,
|
|
157
158
|
si_users_path_template: null,
|
|
158
159
|
target_location: null,
|
|
160
|
+
target_name: null,
|
|
159
161
|
token: null,
|
|
160
162
|
type: null,
|
|
161
163
|
uid_token: null,
|
|
@@ -76,6 +76,7 @@
|
|
|
76
76
|
| **si_users_ignore** | **String** | Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration) | [optional] |
|
|
77
77
|
| **si_users_path_template** | **String** | Path location template for migrating users as Rotated Secrets e.g.: .../Users/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Server Inventory migration) | |
|
|
78
78
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
79
|
+
| **target_name** | **String** | Name of existing target to use to create the migration | [optional] |
|
|
79
80
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
80
81
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
81
82
|
| **usc_name** | **String** | Universal Secret Connector name | [optional] |
|
|
@@ -159,6 +160,7 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
159
160
|
si_users_ignore: null,
|
|
160
161
|
si_users_path_template: null,
|
|
161
162
|
target_location: null,
|
|
163
|
+
target_name: null,
|
|
162
164
|
token: null,
|
|
163
165
|
uid_token: null,
|
|
164
166
|
usc_name: null,
|
data/docs/GetKubeExecCreds.md
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
| **key_data_base64** | **String** | PKI key file contents. If this option is used, the certificate will be printed to stdout | [optional] |
|
|
16
16
|
| **max_path_len** | **Integer** | The maximum path length for the generated certificate. -1, means unlimited unless the signing certificate has a maximum path length set | [optional][default to -1] |
|
|
17
17
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
18
|
-
| **ttl** | **String** | Updated certificate lifetime in seconds (must be less than the Certificate Issuer default TTL) | [optional] |
|
|
18
|
+
| **ttl** | **String** | Updated certificate lifetime in seconds (must be less than the Certificate Issuer default TTL). Ignored for Let's Encrypt public CA issuers, which always use the CA default lifetime (about 90 days). | [optional] |
|
|
19
19
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
20
20
|
| **uri_sans** | **String** | The URI Subject Alternative Names to be included in the PKI certificate (in a comma-separated list) (if CSR is supplied this flag is ignored and any URI.* names are taken from it) | [optional] |
|
|
21
21
|
|
data/docs/GetPKICertificate.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
| **key_data_base64** | **String** | PKI key file contents. If this option is used, the certificate will be printed to stdout | [optional] |
|
|
15
15
|
| **max_path_len** | **Integer** | The maximum path length for the generated certificate. -1, means unlimited unless the signing certificate has a maximum path length set | [optional][default to -1] |
|
|
16
16
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
17
|
-
| **ttl** | **String** | Updated certificate lifetime in seconds (must be less than the Certificate Issuer default TTL) | [optional] |
|
|
17
|
+
| **ttl** | **String** | Updated certificate lifetime in seconds (must be less than the Certificate Issuer default TTL). Ignored for Let's Encrypt public CA issuers, which always use the CA default lifetime (about 90 days). | [optional] |
|
|
18
18
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
19
19
|
| **uri_sans** | **String** | The URI Subject Alternative Names to be included in the PKI certificate (in a comma-separated list) (if CSR is supplied this flag is ignored and any URI.* names are taken from it) | [optional] |
|
|
20
20
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Akeyless::GrokTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key** | **String** | | [optional] |
|
|
8
|
+
| **grok_url** | **String** | | [optional] |
|
|
9
|
+
| **team_id** | **String** | TeamID is the xAI team this API key belongs to. Stored only; not sent to xAI by the gateway. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'akeyless'
|
|
15
|
+
|
|
16
|
+
instance = Akeyless::GrokTargetDetails.new(
|
|
17
|
+
api_key: null,
|
|
18
|
+
grok_url: null,
|
|
19
|
+
team_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/HashiPayload.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **delete_sync_on_deletion** | **Boolean** | | [optional] |
|
|
8
|
+
| **hashi_target_id** | **Integer** | | [optional] |
|
|
8
9
|
| **import_as_json** | **Boolean** | | [optional] |
|
|
9
10
|
| **metadata_mode** | **String** | | [optional] |
|
|
10
11
|
| **namespaces** | **Array<String>** | | [optional] |
|
|
@@ -19,6 +20,7 @@ require 'akeyless'
|
|
|
19
20
|
|
|
20
21
|
instance = Akeyless::HashiPayload.new(
|
|
21
22
|
delete_sync_on_deletion: null,
|
|
23
|
+
hashi_target_id: null,
|
|
22
24
|
import_as_json: null,
|
|
23
25
|
metadata_mode: null,
|
|
24
26
|
namespaces: null,
|
data/docs/Item.md
CHANGED
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
| **delete_protection** | **Boolean** | | [optional] |
|
|
19
19
|
| **deletion_date** | **Time** | | [optional] |
|
|
20
20
|
| **display_id** | **String** | | [optional] |
|
|
21
|
+
| **file_download** | [**FileDownloadInstructions**](FileDownloadInstructions.md) | | [optional] |
|
|
21
22
|
| **gateway_details** | [**Array<GatewayDetailsForItemReplyObj>**](GatewayDetailsForItemReplyObj.md) | | [optional] |
|
|
22
23
|
| **is_access_request_enabled** | **Boolean** | | [optional] |
|
|
23
24
|
| **is_enabled** | **Boolean** | | [optional] |
|
|
@@ -69,6 +70,7 @@ instance = Akeyless::Item.new(
|
|
|
69
70
|
delete_protection: null,
|
|
70
71
|
deletion_date: null,
|
|
71
72
|
display_id: null,
|
|
73
|
+
file_download: null,
|
|
72
74
|
gateway_details: null,
|
|
73
75
|
is_access_request_enabled: null,
|
|
74
76
|
is_enabled: null,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Akeyless::KeycloakTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **keycloak_client_id** | **String** | | [optional] |
|
|
8
|
+
| **keycloak_client_secret** | **String** | | [optional] |
|
|
9
|
+
| **keycloak_realm** | **String** | | [optional] |
|
|
10
|
+
| **keycloak_url** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'akeyless'
|
|
16
|
+
|
|
17
|
+
instance = Akeyless::KeycloakTargetDetails.new(
|
|
18
|
+
keycloak_client_id: null,
|
|
19
|
+
keycloak_client_secret: null,
|
|
20
|
+
keycloak_realm: null,
|
|
21
|
+
keycloak_url: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::OktaTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **okta_api_token** | **String** | | [optional] |
|
|
8
|
+
| **okta_url** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::OktaTargetDetails.new(
|
|
16
|
+
okta_api_token: null,
|
|
17
|
+
okta_url: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
| **agent_id** | **String** | Agent identifier for auditing | |
|
|
8
8
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
9
|
| **name** | **String** | Secret name (dynamic secret or rotated secret) | |
|
|
10
|
+
| **original_prompt** | **String** | Original natural-language prompt from the user (optional, for auditing) | [optional] |
|
|
11
|
+
| **original_user** | **String** | Human end-user behind the agent (optional, for auditing) | [optional] |
|
|
10
12
|
| **payload** | **String** | Query or action payload (SQL, natural language, or CLI-style) | |
|
|
11
13
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
12
14
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
@@ -20,6 +22,8 @@ instance = Akeyless::RuntimeAuthorityCommand.new(
|
|
|
20
22
|
agent_id: null,
|
|
21
23
|
json: null,
|
|
22
24
|
name: null,
|
|
25
|
+
original_prompt: null,
|
|
26
|
+
original_user: null,
|
|
23
27
|
payload: null,
|
|
24
28
|
token: null,
|
|
25
29
|
uid_token: null
|
data/docs/SAMLAccessRules.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **idp_metadata_url** | **String** | IDP metadata url | [optional] |
|
|
10
10
|
| **idp_metadata_xml** | **String** | IDP metadata XML | [optional] |
|
|
11
11
|
| **unique_identifier** | **String** | A unique identifier to distinguish different users | [optional] |
|
|
12
|
+
| **use_dedicated_saml_urls** | **Boolean** | When true, the login AuthnRequest is signed with this access method's dedicated SP identity (Entity ID https://<sp>/saml/sp/{access_id} and ACS https://<sp>/saml/acs/{access_id}) instead of the shared global identity. Default false keeps the legacy global identity for backward compatibility. | [optional] |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,7 +21,8 @@ instance = Akeyless::SAMLAccessRules.new(
|
|
|
20
21
|
bound_attributes: null,
|
|
21
22
|
idp_metadata_url: null,
|
|
22
23
|
idp_metadata_xml: null,
|
|
23
|
-
unique_identifier: null
|
|
24
|
+
unique_identifier: null,
|
|
25
|
+
use_dedicated_saml_urls: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
26
28
|
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_info** | [**FileInfo**](FileInfo.md) | | [optional] |
|
|
7
8
|
| **format** | **String** | StaticSecretFormat defines the format of static secret (e.g. Text) | [optional] |
|
|
8
9
|
| **max_versions** | **Integer** | | [optional] |
|
|
9
10
|
| **notify_on_change_event** | **Boolean** | | [optional] |
|
|
@@ -18,6 +19,7 @@
|
|
|
18
19
|
require 'akeyless'
|
|
19
20
|
|
|
20
21
|
instance = Akeyless::StaticSecretDetailsInfo.new(
|
|
22
|
+
file_info: null,
|
|
21
23
|
format: null,
|
|
22
24
|
max_versions: null,
|
|
23
25
|
notify_on_change_event: null,
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Akeyless::TargetCreateAnthropic
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **anthropic_url** | **String** | Base URL of the Anthropic API | [optional][default to 'https://api.anthropic.com'] |
|
|
8
|
+
| **api_key** | **String** | API key for Anthropic | [optional] |
|
|
9
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
10
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
12
|
+
| **key** | **String** | The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
13
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
14
|
+
| **name** | **String** | Target name | |
|
|
15
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
16
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'akeyless'
|
|
22
|
+
|
|
23
|
+
instance = Akeyless::TargetCreateAnthropic.new(
|
|
24
|
+
anthropic_url: null,
|
|
25
|
+
api_key: null,
|
|
26
|
+
delete_protection: null,
|
|
27
|
+
description: null,
|
|
28
|
+
json: null,
|
|
29
|
+
key: null,
|
|
30
|
+
max_versions: null,
|
|
31
|
+
name: null,
|
|
32
|
+
token: null,
|
|
33
|
+
uid_token: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Akeyless::TargetCreateBedrock
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key** | **String** | API key for Bedrock | [optional] |
|
|
8
|
+
| **bedrock_url** | **String** | Base URL of the Bedrock API | [optional][default to 'https://bedrock-runtime.us-east-1.amazonaws.com'] |
|
|
9
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
10
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
12
|
+
| **key** | **String** | The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
13
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
14
|
+
| **name** | **String** | Target name | |
|
|
15
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
16
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'akeyless'
|
|
22
|
+
|
|
23
|
+
instance = Akeyless::TargetCreateBedrock.new(
|
|
24
|
+
api_key: null,
|
|
25
|
+
bedrock_url: null,
|
|
26
|
+
delete_protection: null,
|
|
27
|
+
description: null,
|
|
28
|
+
json: null,
|
|
29
|
+
key: null,
|
|
30
|
+
max_versions: null,
|
|
31
|
+
name: null,
|
|
32
|
+
token: null,
|
|
33
|
+
uid_token: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Akeyless::TargetCreateCustomDns
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
8
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
9
|
+
| **dns_parameter** | **Hash<String, String>** | Lego DNS provider parameters as KEY=VALUE pairs using lego environment variable names | |
|
|
10
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
11
|
+
| **key** | **String** | The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
12
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
13
|
+
| **name** | **String** | Target name | |
|
|
14
|
+
| **provider_type** | **String** | Lego DNS provider code (e.g. infoblox, route53, azion). See https://go-acme.github.io/lego/dns/ | |
|
|
15
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
16
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'akeyless'
|
|
22
|
+
|
|
23
|
+
instance = Akeyless::TargetCreateCustomDns.new(
|
|
24
|
+
delete_protection: null,
|
|
25
|
+
description: null,
|
|
26
|
+
dns_parameter: null,
|
|
27
|
+
json: null,
|
|
28
|
+
key: null,
|
|
29
|
+
max_versions: null,
|
|
30
|
+
name: null,
|
|
31
|
+
provider_type: null,
|
|
32
|
+
token: null,
|
|
33
|
+
uid_token: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
data/docs/TargetCreateDB.md
CHANGED
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
| **parent_target_name** | **String** | Name of the parent target, relevant only when connection-type is parent-target | [optional] |
|
|
40
40
|
| **port** | **String** | | [optional] |
|
|
41
41
|
| **pwd** | **String** | | [optional] |
|
|
42
|
+
| **skip_server_name_validation** | **String** | (Optional) Skip server name verification | [optional] |
|
|
42
43
|
| **snowflake_account** | **String** | | [optional] |
|
|
43
44
|
| **snowflake_api_private_key** | **String** | RSA Private key (base64 encoded) | [optional] |
|
|
44
45
|
| **snowflake_api_private_key_password** | **String** | The Private key passphrase | [optional] |
|
|
@@ -89,6 +90,7 @@ instance = Akeyless::TargetCreateDB.new(
|
|
|
89
90
|
parent_target_name: null,
|
|
90
91
|
port: null,
|
|
91
92
|
pwd: null,
|
|
93
|
+
skip_server_name_validation: null,
|
|
92
94
|
snowflake_account: null,
|
|
93
95
|
snowflake_api_private_key: null,
|
|
94
96
|
snowflake_api_private_key_password: null,
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Akeyless::TargetCreateGrok
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key** | **String** | API key for xAI (Grok) | [optional] |
|
|
8
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
10
|
+
| **grok_url** | **String** | Base URL of the xAI API | [optional][default to 'https://api.x.ai/v1'] |
|
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
12
|
+
| **key** | **String** | The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
13
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
14
|
+
| **name** | **String** | Target name | |
|
|
15
|
+
| **team_id** | **String** | ID of the team this API key belongs to | [optional] |
|
|
16
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
17
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'akeyless'
|
|
23
|
+
|
|
24
|
+
instance = Akeyless::TargetCreateGrok.new(
|
|
25
|
+
api_key: null,
|
|
26
|
+
delete_protection: null,
|
|
27
|
+
description: null,
|
|
28
|
+
grok_url: null,
|
|
29
|
+
json: null,
|
|
30
|
+
key: null,
|
|
31
|
+
max_versions: null,
|
|
32
|
+
name: null,
|
|
33
|
+
team_id: null,
|
|
34
|
+
token: null,
|
|
35
|
+
uid_token: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Akeyless::TargetCreateKeycloak
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **client_id** | **String** | Keycloak service account client ID | [optional] |
|
|
8
|
+
| **client_secret** | **String** | Keycloak service account client secret | [optional] |
|
|
9
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
10
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
12
|
+
| **key** | **String** | The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
13
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
14
|
+
| **name** | **String** | Target name | |
|
|
15
|
+
| **realm** | **String** | Keycloak realm | [optional] |
|
|
16
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
17
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
18
|
+
| **url** | **String** | Keycloak URL | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'akeyless'
|
|
24
|
+
|
|
25
|
+
instance = Akeyless::TargetCreateKeycloak.new(
|
|
26
|
+
client_id: null,
|
|
27
|
+
client_secret: null,
|
|
28
|
+
delete_protection: null,
|
|
29
|
+
description: null,
|
|
30
|
+
json: null,
|
|
31
|
+
key: null,
|
|
32
|
+
max_versions: null,
|
|
33
|
+
name: null,
|
|
34
|
+
realm: null,
|
|
35
|
+
token: null,
|
|
36
|
+
uid_token: null,
|
|
37
|
+
url: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|