SecretUpdateArgs

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://docs.delinea.com/online-help/secret-server/api-scripting/rest-api/schemas/SecretUpdateArgs",
  "title": "SecretUpdateArgs",
  "description": "Secret update options",
  "required": [
    "id",
    "name",
    "items"
  ],
  "properties": {
    "accessRequestWorkflowMapId": {
      "description": "The id of the mapping entity that associates this secret to a specific access request workflow.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "active": {
      "description": "Whether the secret is in an active or deleted state.",
      "type": "boolean"
    },
    "autoChangeEnabled": {
      "description": "Whether the secret\u2019s password is automatically rotated on a schedule.",
      "type": "boolean"
    },
    "autoChangeNextPassword": {
      "description": "Whether the secret should be flagged for immediate password change.",
      "type": "string"
    },
    "checkOutChangePasswordEnabled": {
      "description": "Whether the secret\u2019s password is automatically changed when a secret is checked in. This is a security feature that prevents a use of the password retrieved from check-out after the secret is checked in.",
      "type": "boolean"
    },
    "checkOutEnabled": {
      "description": "Whether the user must check-out the secret to view it. Checking out gives the user exclusive access to the secret for a specified period or until the secret is checked in.",
      "type": "boolean"
    },
    "checkOutIntervalMinutes": {
      "description": "The number of minutes that a secret will remain checked out.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "comment": {
      "description": "If the secret requires a comment to view or requires approval to view, a reason for accessing the secret must be provided.",
      "type": "string"
    },
    "doubleLockPassword": {
      "description": "If the secret is DoubleLocked, this is the DoubleLock password needed to access the secret.",
      "type": "string"
    },
    "enableInheritPermissions": {
      "description": "Whether the secret inherits permissions from the containing folder.",
      "type": "boolean",
      "nullable": true
    },
    "enableInheritSecretPolicy": {
      "description": "Whether the secret policy is inherited from the containing folder.",
      "type": "boolean"
    },
    "folderId": {
      "description": "If the secret is contained in a folder, the id of the containing folder. Set to null or -1 for secrets that are in the root folder.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "forceCheckIn": {
      "description": "Force the secret to be checked in, even if checked out by someone else. The user must have the \"Force Check In\" permission.",
      "type": "boolean"
    },
    "id": {
      "description": "The id of the Secret to update. Must match the {id} in the path.",
      "type": "integer",
      "format": "int32",
      "minimum": 1
    },
    "includeInactive": {
      "description": "If the secret is deactivated, this must be set to true in order to access the secret. The user must also have the \"View Inactive Secrets\" permission.",
      "type": "boolean"
    },
    "items": {
      "description": "A list of secret item field values.",
      "items": {
        "$ref": "#/components/schemas/RestSecretItem"
      },
      "type": "array"
    },
    "launcherConnectAsSecretId": {
      "description": "When an SSH secret is proxied, you can choose to connect as another user and then do an su to the current secret\u2019s user. This is a common practice for connecting with a lower privileged account and then switching to the root user.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "name": {
      "description": "The name to display for the secret.",
      "type": "string"
    },
    "newPassword": {
      "description": "New secret password.",
      "type": "string"
    },
    "noAutoCheckout": {
      "description": "Don't check out the secret automatically.",
      "type": "boolean"
    },
    "passwordTypeWebScriptId": {
      "description": "The id of the password change script to use on applicable web password secrets.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "proxyEnabled": {
      "description": "Whether sessions launched on this secret use Secret Server\u2019s proxying or connect directly.",
      "type": "boolean"
    },
    "requiresComment": {
      "description": "Whether the user must enter a comment to view the secret.",
      "type": "boolean"
    },
    "secretPolicyId": {
      "description": "The id of the secret policy that controls the security and other settings of the secret. Set to null to not assign a secret policy.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "sessionRecordingEnabled": {
      "description": "Whether session recording is enabled.",
      "type": "boolean"
    },
    "siteId": {
      "description": "The id of the distributed engine site that is used by this secret for operations such as password changing.",
      "type": "integer",
      "format": "int32",
      "minimum": 1
    },
    "sshKeyArgs": {
      "$ref": "#/components/schemas/SshKeyArgs"
    },
    "ticketNumber": {
      "description": "If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the ticket number to the help desk request.",
      "type": "string"
    },
    "ticketSystemId": {
      "description": "If the secret requires a comment to view or requires approval and a user must provide a help desk a ticket number, this is the id of the help desk system configured in Secret Server that should be used to validate the ticket number.",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "webLauncherRequiresIncognitoMode": {
      "description": "Whether the web launcher will require the browser to run in incognito mode.",
      "type": "boolean",
      "nullable": true
    }
  },
  "type": "object"
}