SecretCreateArgs

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://docs.delinea.com/online-help/secret-server/api-scripting/rest-api/schemas/SecretCreateArgs",
  "title": "SecretCreateArgs",
  "description": "Secret create options",
  "required": [
    "name",
    "secretTemplateId",
    "items"
  ],
  "properties": {
    "autoChangeEnabled": {
      "description": "Whether the secret\u2019s password is automatically rotated on a schedule.",
      "type": "boolean"
    },
    "changePasswordNow": {
      "description": "Whether the Secret should be immediately queued for Remote Password Change upon successful import.",
      "type": "boolean"
    },
    "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
    },
    "delayIndexing": {
      "description": "Whether the search indexing should be delayed to the background process. This can speed up bulk secret creation scripts by offloading the task of indexing the new secrets to the background task at the trade-off of not having search indexes immediately available.",
      "type": "boolean",
      "nullable": true
    },
    "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
    },
    "items": {
      "description": "An array of values for the secret fields defined in the secret template.",
      "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"
    },
    "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
    },
    "secretTemplateId": {
      "description": "The id of the secret template that defines the fields and properties of the secret.",
      "type": "integer",
      "format": "int32",
      "minimum": 1
    },
    "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"
    },
    "webLauncherRequiresIncognitoMode": {
      "description": "Whether the web launcher will require the browser to run in incognito mode.",
      "type": "boolean"
    }
  },
  "type": "object"
}