RotatedSecretCreateOpenAI.md

Akeyless::RotatedSecretCreateOpenAI

Properties

Name	Type	Description	Notes
api_key	String	Admin API key value to rotate (relevant only for rotator-type=api-key)	[optional]
api_key_id	String	Admin API key ID to rotate (relevant only for rotator-type=api-key)	[optional]
ara_enabled	Boolean	Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag.	[optional]
authentication_credentials	String	The credentials to connect with use-user-creds/use-target-creds	[optional][default to 'use-user-creds']
auto_rotate	String		[optional]
delete_protection	String	Protection from accidental deletion of this object [true/false]	[optional]
description	String	Description of the object	[optional]
input_rule	Array<String>	Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)	[optional]
item_custom_fields	Hash<String, String>	Additional custom fields to associate with the item	[optional]
json	Boolean	Set output format to JSON	[optional][default to false]
key	String		[optional]
max_versions	String	Set the maximum number of versions, limited by the account settings defaults.	[optional]
name	String	Rotated secret name
output_rule	Array<String>	Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)	[optional]
password_length	String	The length of the password to be generated	[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		[optional]
rotation_interval	String		[optional]
rotator_type	String	The rotator type. options: [target/api-key]
skip_dry_run	String	If set, dry-run will be skipped	[optional]
tags	Array<String>	Add tags attached to this object	[optional]
target_name	String	The target name to associate
token	String	Authentication token (see `/auth` and `/configure`)	[optional]
uid_token	String	The universal identity token, Required only for universal_identity authentication	[optional]
use_capital_letters	String	Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false]	[optional]
use_lower_letters	String	Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false]	[optional]
use_numbers	String	Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false]	[optional]
use_special_characters	String		[optional]

Example

require 'akeyless'

instance = Akeyless::RotatedSecretCreateOpenAI.new(
  api_key: null,
  api_key_id: null,
  ara_enabled: null,
  authentication_credentials: null,
  auto_rotate: null,
  delete_protection: null,
  description: null,
  input_rule: null,
  item_custom_fields: null,
  json: null,
  key: null,
  max_versions: null,
  name: null,
  output_rule: null,
  password_length: null,
  rotation_event_in: null,
  rotation_hour: null,
  rotation_interval: null,
  rotator_type: null,
  skip_dry_run: null,
  tags: null,
  target_name: null,
  token: null,
  uid_token: null,
  use_capital_letters: null,
  use_lower_letters: null,
  use_numbers: null,
  use_special_characters: ! @ # $. [true/false]
)