Safe Members workflows
This topic provides input and output elements for the workflows in the Safe Members folder.
List Safe Members workflow
This operation returns a list of the members in the safe.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is List Safe Members.
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 whose safe members will be listed. | 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. |
Add Safe Member workflow
This operation adds an existing user as a safe member.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Add Safe Member.
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 add a member. | Yes |
body parameters | Specifies the body parameters in JSON format to provide the member details to be added to the safe. | 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 returned by the operation. |
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 Member workflow
This operation updates an existing safe member.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Update Safe Member.
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 update an existing safe member. | Yes |
safe member name | Specifies the vault/domain user/group member to update. | |
body parameters | Specifies the body parameters in JSON format to provide the member details to be updated to the safe. | 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. |
Delete Safe Member workflow
This operation removes a specific member from a safe.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is Delete Safe Member.
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 from which the member is to be deleted. | Yes |
safe member name | Specifies the name of the Safe member to delete from the safe's list of members. | 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. |