Delinea · Schema
SecretModel
Secret
Privileged Access ManagementPAMSecrets ManagementIdentity SecurityDevOpsCybersecurity
Properties
| Name | Type | Description |
|---|---|---|
| accessRequestWorkflowMapId | integer | AccessRequestWorkflowMapId |
| active | boolean | Whether the secret is active |
| allowOwnersUnrestrictedSshCommands | boolean | AllowOwnersUnrestrictedSshCommands |
| autoChangeEnabled | boolean | AutoChangeEnabled |
| autoChangeNextPassword | string | AutoChangeNextPassword |
| checkedOut | boolean | Whether the secret is currently checked out |
| checkOutChangePasswordEnabled | boolean | CheckOutChangePasswordEnabled |
| checkOutEnabled | boolean | Whether secret checkout is enabled |
| checkOutIntervalMinutes | integer | Checkout interval, in minutes |
| checkOutMinutesRemaining | integer | Minutes remaining in current checkout interval |
| checkOutUserDisplayName | string | Name of user who has checked out the secret |
| checkOutUserId | integer | ID of user who has checked out the secret |
| doubleLockId | integer | DoubleLockId |
| enableInheritPermissions | boolean | EnableInheritPermissions |
| enableInheritSecretPolicy | boolean | Whether the secret policy is inherited from the containing folder |
| failedPasswordChangeAttempts | integer | Number of failed password change attempts |
| folderId | integer | Containing folder ID |
| id | integer | Secret ID |
| isDoubleLock | boolean | Whether double lock is enabled |
| isOutOfSync | boolean | Out of sync indicates that a Password is setup for autochange and has failed its last password change attempt or has exceeded the maximum RPC attempts |
| isRestricted | boolean | Whether the secret is restricted |
| items | array | Secret data fields |
| jumpboxRouteId | string | JumpboxRouteId |
| lastHeartBeatCheck | string | Time of last heartbeat check |
| lastHeartBeatStatus | object | |
| lastPasswordChangeAttempt | string | Time of most recent password change attempt |
| launcherConnectAsSecretId | integer | LauncherConnectAsSecretId |
| name | string | Secret name |
| outOfSyncReason | string | Reason message if the secret is out of sync |
| passwordTypeWebScriptId | integer | PasswordTypeWebScriptId |
| proxyEnabled | boolean | ProxyEnabled |
| requiresApprovalForAccess | boolean | RequiresApprovalForAccess |
| requiresComment | boolean | RequiresComment |
| responseCodes | array | ResponseCodes |
| restrictSshCommands | boolean | RestrictSshCommands |
| secretPolicyId | integer | SecretPolicyId |
| secretTemplateId | integer | Secret template ID |
| secretTemplateName | string | Name of secret template |
| sessionRecordingEnabled | boolean | Whether session recording is enabled |
| siteId | integer | SiteId |
| webLauncherRequiresIncognitoMode | boolean | WebLauncherRequiresIncognitoMode |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://docs.delinea.com/online-help/secret-server/api-scripting/rest-api/schemas/SecretModel",
"title": "SecretModel",
"description": "Secret",
"properties": {
"accessRequestWorkflowMapId": {
"description": "AccessRequestWorkflowMapId",
"type": "integer",
"format": "int32",
"nullable": true
},
"active": {
"description": "Whether the secret is active",
"type": "boolean"
},
"allowOwnersUnrestrictedSshCommands": {
"description": "AllowOwnersUnrestrictedSshCommands",
"type": "boolean"
},
"autoChangeEnabled": {
"description": "AutoChangeEnabled",
"type": "boolean"
},
"autoChangeNextPassword": {
"description": "AutoChangeNextPassword",
"type": "string"
},
"checkedOut": {
"description": "Whether the secret is currently checked out",
"type": "boolean"
},
"checkOutChangePasswordEnabled": {
"description": "CheckOutChangePasswordEnabled",
"type": "boolean"
},
"checkOutEnabled": {
"description": "Whether secret checkout is enabled",
"type": "boolean"
},
"checkOutIntervalMinutes": {
"description": "Checkout interval, in minutes",
"type": "integer",
"format": "int32"
},
"checkOutMinutesRemaining": {
"description": "Minutes remaining in current checkout interval",
"type": "integer",
"format": "int32"
},
"checkOutUserDisplayName": {
"description": "Name of user who has checked out the secret",
"type": "string"
},
"checkOutUserId": {
"description": "ID of user who has checked out the secret",
"type": "integer",
"format": "int32"
},
"doubleLockId": {
"description": "DoubleLockId",
"type": "integer",
"format": "int32"
},
"enableInheritPermissions": {
"description": "EnableInheritPermissions",
"type": "boolean"
},
"enableInheritSecretPolicy": {
"description": "Whether the secret policy is inherited from the containing folder",
"type": "boolean"
},
"failedPasswordChangeAttempts": {
"description": "Number of failed password change attempts",
"type": "integer",
"format": "int32"
},
"folderId": {
"description": "Containing folder ID",
"type": "integer",
"format": "int32"
},
"id": {
"description": "Secret ID",
"type": "integer",
"format": "int32"
},
"isDoubleLock": {
"description": "Whether double lock is enabled",
"type": "boolean"
},
"isOutOfSync": {
"description": "Out of sync indicates that a Password is setup 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"
},
"items": {
"description": "Secret data fields",
"items": {
"$ref": "#/components/schemas/RestSecretItem"
},
"type": "array"
},
"jumpboxRouteId": {
"description": "JumpboxRouteId",
"type": "string",
"format": "uuid",
"nullable": true
},
"lastHeartBeatCheck": {
"description": "Time of last heartbeat check",
"type": "string",
"format": "date-time"
},
"lastHeartBeatStatus": {
"$ref": "#/components/schemas/HeartbeatStatus"
},
"lastPasswordChangeAttempt": {
"description": "Time of most recent password change attempt",
"type": "string",
"format": "date-time"
},
"launcherConnectAsSecretId": {
"description": "LauncherConnectAsSecretId",
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"description": "Secret name",
"type": "string"
},
"outOfSyncReason": {
"description": "Reason message if the secret is out of sync",
"type": "string"
},
"passwordTypeWebScriptId": {
"description": "PasswordTypeWebScriptId",
"type": "integer",
"format": "int32"
},
"proxyEnabled": {
"description": "ProxyEnabled",
"type": "boolean"
},
"requiresApprovalForAccess": {
"description": "RequiresApprovalForAccess",
"type": "boolean"
},
"requiresComment": {
"description": "RequiresComment",
"type": "boolean"
},
"responseCodes": {
"description": "ResponseCodes",
"items": {
"type": "string"
},
"type": "array"
},
"restrictSshCommands": {
"description": "RestrictSshCommands",
"type": "boolean"
},
"secretPolicyId": {
"description": "SecretPolicyId",
"type": "integer",
"format": "int32"
},
"secretTemplateId": {
"description": "Secret template ID",
"type": "integer",
"format": "int32"
},
"secretTemplateName": {
"description": "Name of secret template",
"type": "string"
},
"sessionRecordingEnabled": {
"description": "Whether session recording is enabled",
"type": "boolean"
},
"siteId": {
"description": "SiteId",
"type": "integer",
"format": "int32"
},
"webLauncherRequiresIncognitoMode": {
"description": "WebLauncherRequiresIncognitoMode",
"type": "boolean"
}
},
"type": "object"
}