Get secret versions

This method returns all secret versions.

To run this service, the user must have the following Safe member authorizations:

  • List accounts

  • View Safe members

URL

 
https://<subdomain>.privilegecloud.cyberark.com/PasswordVault/API/Accounts/<AccountID>/Secret/Versions/
  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

Resource information

HTTP method

Content type

GET

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64. See Authentication.

Type: String

Mandatory: Yes

Default value: None

URL parameters

 
api/Accounts/{accountId}/Secret/Versions?showTemporary=<true/false>

Parameter

Description

accountID

The unique ID of the account.

Type: String

Mandatory: Yes

Default value: None

showTemporary

Whether to return both permanent and temporary secret versions or only permanent versions.

Type: Boolean

Mandatory: No

Default value: False

Result

 
{

"Versions":[

{

"isTemporary": <false/true>

"modificationDate": <time format>

"modifiedBy": "<user name>"

"versionId":<number>

},

{

"isTemporary": <false/true>

"modificationDate": <time format>

"modifiedBy": "<user name>"

"versionId":<number>

}]

}

Parameter

Description

versionID

The unique ID of the secret's version.

Type: Number

modifiedBy

The user that modified the secret.

Type: String

modificationDate

The secret's modification date.

Type: Date/Time

isTemporary

Whether the secret is a temporary or permanent secret.

Type: String

Return codes

For a complete list of return codes, see Return Codes.