Delinea · Schema

SecretSummary

Secret summary

Privileged Access ManagementPAMSecrets ManagementIdentity SecurityDevOpsCybersecurity

Properties

Name Type Description
active boolean Whether the secret is active
autoChangeEnabled boolean Indicates whether or not this Secret an auto changing password
checkedOut boolean Whether the secret is currently checked out
checkOutEnabled boolean Indicates whether or not checkout is enabled for the Secret
checkOutUserId integer Id of the User that has the secret checked out if it is checked out
checkOutUserName string The name of the User that has the secret checked out if it is checked out
createDate string When the Secret was created
daysUntilExpiration integer How many days until this Secret expires
doubleLockEnabled boolean Indicates whether or not DoubleLock is enabled for this password
extendedFields array Any requested extended fields from a lookup request
folderId integer Containing folder ID
folderPath string Containing folder path
hasLauncher boolean Indicates if this Secret has any launchers
hidePassword boolean Indicates if the launcher password is set to be hidden
id integer Secret ID
inheritsPermissions boolean Indicates if this Secret inherits permissions from its folder
isOutOfSync boolean Indicates that Heartbeat has failed or a Password is set up for autochange and has failed its last password change attempt or has exceeded the maximum RPC attempts
isRestricted boolean Whether the secret is restricted
lastAccessed string When the Secret was last viewed by the current User
lastHeartBeatStatus object
lastPasswordChangeAttempt string Time of most recent password change attempt
name string Secret name
outOfSyncReason string Reason message if the secret is out of sync
requiresApproval boolean Indicates if this Secret requires approval
requiresComment boolean Indicates if this Secret requires comment
responseCodes array ResponseCodes
secretTemplateId integer Secret template ID
secretTemplateName string Name of secret template
siteId integer SiteId
View JSON Schema on GitHub

JSON Schema

secretsummary.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://docs.delinea.com/online-help/secret-server/api-scripting/rest-api/schemas/SecretSummary",
  "title": "SecretSummary",
  "description": "Secret summary",
  "properties": {
    "active": {
      "description": "Whether the secret is active",
      "type": "boolean"
    },
    "autoChangeEnabled": {
      "description": "Indicates whether or not this Secret an auto changing password",
      "type": "boolean",
      "nullable": true
    },
    "checkedOut": {
      "description": "Whether the secret is currently checked out",
      "type": "boolean"
    },
    "checkOutEnabled": {
      "description": "Indicates whether or not checkout is enabled for the Secret",
      "type": "boolean",
      "nullable": true
    },
    "checkOutUserId": {
      "description": "Id of the User that has the secret checked out if it is checked out",
      "type": "integer",
      "format": "int32"
    },
    "checkOutUserName": {
      "description": "The name of the User that has the secret checked out if it is checked out",
      "type": "string"
    },
    "createDate": {
      "description": "When the Secret was created",
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "daysUntilExpiration": {
      "description": "How many days until this Secret expires",
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "doubleLockEnabled": {
      "description": "Indicates whether or not DoubleLock is enabled for this password",
      "type": "boolean",
      "nullable": true
    },
    "extendedFields": {
      "description": "Any requested extended fields from a lookup request",
      "items": {
        "$ref": "#/components/schemas/ISecretSummaryExtendedField"
      },
      "type": "array"
    },
    "folderId": {
      "description": "Containing folder ID",
      "type": "integer",
      "format": "int32"
    },
    "folderPath": {
      "description": "Containing folder path",
      "type": "string"
    },
    "hasLauncher": {
      "description": "Indicates if this Secret has any launchers",
      "type": "boolean"
    },
    "hidePassword": {
      "description": "Indicates if the launcher password is set to be hidden",
      "type": "boolean",
      "nullable": true
    },
    "id": {
      "description": "Secret ID",
      "type": "integer",
      "format": "int32"
    },
    "inheritsPermissions": {
      "description": "Indicates if this Secret inherits permissions from its folder",
      "type": "boolean",
      "nullable": true
    },
    "isOutOfSync": {
      "description": "Indicates that Heartbeat has failed or a Password is set up for autochange and has failed its last password change attempt or has exceeded the maximum RPC attempts",
      "type": "boolean"
    },
    "isRestricted": {
      "description": "Whether the secret is restricted",
      "type": "boolean"
    },
    "lastAccessed": {
      "description": "When the Secret was last viewed by the current User",
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "lastHeartBeatStatus": {
      "$ref": "#/components/schemas/HeartbeatStatus"
    },
    "lastPasswordChangeAttempt": {
      "description": "Time of most recent password change attempt",
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "name": {
      "description": "Secret name",
      "type": "string"
    },
    "outOfSyncReason": {
      "description": "Reason message if the secret is out of sync",
      "type": "string"
    },
    "requiresApproval": {
      "description": "Indicates if this Secret requires approval",
      "type": "boolean",
      "nullable": true
    },
    "requiresComment": {
      "description": "Indicates if this Secret requires comment",
      "type": "boolean",
      "nullable": true
    },
    "responseCodes": {
      "description": "ResponseCodes",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "secretTemplateId": {
      "description": "Secret template ID",
      "type": "integer",
      "format": "int32"
    },
    "secretTemplateName": {
      "description": "Name of secret template",
      "type": "string"
    },
    "siteId": {
      "description": "SiteId",
      "type": "integer",
      "format": "int32"
    }
  },
  "type": "object"
}