Skip to content

Latest commit

 

History

History
76 lines (70 loc) · 4.35 KB

GatewayUpdateItem.md

File metadata and controls

76 lines (70 loc) · 4.35 KB
Raw

Akeyless::GatewayUpdateItem

Properties

Name Type Description Notes
add_tag Array<String> List of the new tags that will be attached to this item [optional]
api_id String API ID to rotate (relevant only for rotator-type=api-key) [optional]
api_key String API key to rotate (relevant only for rotator-type=api-key) [optional]
app_id String ApplicationId (used in azure) [optional]
auto_rotate String Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] [optional]
custom_payload String Secret payload to be sent with rotation request (relevant only for rotator-type=custom) [optional]
delete_protection String Protection from accidental deletion of this object [true/false] [optional]
description String Description of the object [optional][default to 'default_metadata']
gcp_key String Base64-encoded service account private key text [optional]
gcp_service_account_email String The email of the gcp service account to rotate [optional]
gcp_service_account_key_id String The key id of the gcp service account to rotate [optional]
grace_rotation String Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false] [optional]
json Boolean Set output format to JSON [optional][default to false]
keep_prev_version String Whether to keep previous version [true/false]. (relevant only for --type=rotated-secret). If not set, use default according to account settings [optional]
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]
name String Item name
new_metadata String Deprecated - use description [optional][default to 'default_metadata']
new_name String New item name [optional]
new_version Boolean Deprecated [optional]
password_length String The length of the password to be generated [optional]
rm_tag Array<String> List of the existent tags that will be removed from this item [optional]
rotated_password String rotated-username password (relevant only for rotator-type=password) [optional]
rotated_username String username to be rotated, if selected \&quot;use-self-creds\&quot; at rotator-creds-type, this username will try to rotate it's own password, if \&quot;use-target-creds\&quot; is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) [optional]
rotation_event_in Array<String> How many days before the rotation of the item would you like to be notified [optional]
rotation_hour Integer The Rotation Hour [optional][default to 0]
rotation_interval String The number of days to wait between every automatic key rotation (1-365) [optional]
rotator_creds_type String The rotation credentials type [optional][default to 'use-self-creds']
token String Authentication token (see `/auth` and `/configure`) [optional]
type String Item type
uid_token String The universal identity token, Required only for universal_identity authentication [optional]

Example

require 'akeyless'

instance = Akeyless::GatewayUpdateItem.new(
  add_tag: null,
  api_id: null,
  api_key: null,
  app_id: null,
  auto_rotate: null,
  custom_payload: null,
  delete_protection: null,
  description: null,
  gcp_key: null,
  gcp_service_account_email: null,
  gcp_service_account_key_id: null,
  grace_rotation: null,
  json: null,
  keep_prev_version: null,
  key: null,
  name: null,
  new_metadata: null,
  new_name: null,
  new_version: null,
  password_length: null,
  rm_tag: null,
  rotated_password: null,
  rotated_username: null,
  rotation_event_in: null,
  rotation_hour: null,
  rotation_interval: null,
  rotator_creds_type: null,
  token: null,
  type: null,
  uid_token: null
)