Safes workflows
This topic provides input and output elements for the workflows in the Safes folder.
Get Safe Details workflow
This operation returns information about a specific safe in the vault.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Get Safe Details.
The following table describes the input elements for the adapter wrapper process.
Input element | Description | Required |
|---|---|---|
adapter name | Specifies the name of the adapter as configured on the grid. Default name of the adapter is CyberArkActorAdapter. | No |
authorization token | Specifies the authorization token obtained during the logon operation. | Yes |
safe name | Specifies the name of the safe to retrieve its details. | Yes |
return data format | Specifies the data type for the adapter response. Valid values: XML (default), JSON | No |
The following table describes the output elements for the adapter wrapper process.
Output Parameter Name | Description |
|---|---|
status | Shows the status of the operation. Valid values: success, failure |
response body | Specifies the response data. (Empty in case of success) |
status code | Shows a numeric HTTP status code of a response. |
response headers | Contains the response header values, in XML. |
error message | Shows an error message, if the operation fails. |
Add Safe workflow
This operation adds a safe to the vault.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Add Safe.
The following table describes the input elements for the adapter wrapper process.
Input element | Description | Required |
|---|---|---|
adapter name | Specifies the name of the adapter as configured on the grid. Default name of the adapter is CyberArkActorAdapter. | No |
authorization token | Specifies the authorization token obtained during the logon operation. | Yes |
body parameters | Specifies the body parameters, in JSON, to provide the member details to create a safe in CyberArk password vault. Contains the following parameters:
Sample <body-parameters> in JSON { "safe":{ "SafeName":"<Safe name>", "Description":"<Description>", "OLACEnabled":<true/false>, "ManagingCPM":"<CPM user>", "NumberOfVersionsRetention":<1-999> } } | Yes |
return data format | Specifies the data type for the adapter response. Valid values: XML (default), JSON | No |
The following table describes the output elements for the adapter wrapper process.
Output Parameter Name | Description |
|---|---|
status | Shows the status of the operation. Valid values: success, failure |
response body | Specifies the response data. |
status code | Shows a numeric HTTP status code of a response. |
response headers | Contains the response header values, in XML. |
error message | Shows an error message, if the operation fails. |
Update Safe workflow
This operation enables you to update the properties of an existing safe.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Update Safe.
The following table describes the input elements for the adapter wrapper process.
Input element | Description | Required |
|---|---|---|
adapter name | Specifies the name of the adapter as configured on the grid. Default name of the adapter is CyberArkActorAdapter. | No |
authorization token | Specifies the authorization token obtained during the logon operation. | Yes |
safe name | Specifies the name of the existing safe to update its properties. | Yes |
body parameters | Specifies the body parameters, in JSON, to provide the safe details to update a safe in CyberArk password vault. | Yes |
return data format | Specifies the data type for the adapter response. Valid values: XML (default), JSON | No |
The following table describes the output elements for the adapter wrapper process.
Output Parameter Name | Description |
|---|---|
status | Shows the status of the operation. Valid values: success, failure |
response body | Contains the response data. (Empty in case of success) |
status code | Shows a numeric HTTP status code of a response. |
response headers | Contains the response header values, in XML. |
error message | Shows an error message, if the operation fails. |
Delete Safe workflow
This operation deletes a safe from the vault.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Delete Safe.
The following table describes the input elements for the adapter wrapper process.
Input element | Description | Required |
|---|---|---|
adapter name | Specifies the name of the adapter as configured on the grid. Default name of the adapter is CyberArkActorAdapter. | No |
authorization token | Specifies the authorization token obtained during the logon operation. | Yes |
safe name | Specifies the name of the safe to be deleted. | Yes |
return data format | Specifies the data type for the adapter response. Valid values: XML (default), JSON | No |
The following table describes the output elements for the adapter wrapper process.
Output Parameter Name | Description |
|---|---|
status | Shows the status of the operation. Valid values: success, failure |
response body | Specifies the response data. (Empty in case of success) |
status code | Shows a numeric HTTP status code of a response. |
response headers | Contains the response header values, in XML. |
error message | Shows an error message, if the operation fails. |