Skip to Content

Accounts operations workflows

This topic provides input and output elements for the workflows in the Accounts folder.

Get Accounts workflow

This operation returns information about an account.

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
search	Specifies the query parameter key, which is used in the query string in the URL. You can specify a list of keywords separated with a space. Do not use "search=" key. Example: Windows admin	No
safe name	Specifies the safe name to be specified in the filter key, which is used in the query string in the URL.	No
sort	Specifies a query parameter, which is used in the query string in URL.	No
offset	Specifies a query parameter used in the query string in URL, which denotes the offset of the first account that is returned in the collection of results. Valid value: Any integer, 0 (default)	No
limit	Specifies a query parameter that returns the maximum number of accounts. By default, the operation returns maximum 50 accounts. You can specify maximum up to 1000 accounts. Valid value: Any integer, 50 (default) When used together with the <offset> parameter, this value determines the number of accounts to return, starting from the first account that is returned.	No
return data format	Specifies the data type for the adapter response. Valid values: XML (default), JSON Warning Note If you opt for JSON format, then the headers in adapter response will also be converted to JSON and will be assigned in the output context.	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 Get Accounts 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.

Get Account Details workflow

This operation returns the information about an account identified by its ID.

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
account id	Specifies the unique ID of the account. Warning Note The account ID of the user can be retrieved by using Get Account operation.	Yes
return data format	Specifies the data type for the adapter response. Valid values: XML (default), JSON Warning Note If you opt for JSON format, then the headers in adapter response will also be converted to JSON and will be assigned in the output context. Warning Note This parameter is not a part of adapter request XML, it is only used to process adapter response in given format.	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 Account workflow

This operation adds a new privileged account or SSH key to the vault.

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 format to provide the new privileged account details to create an account in the vault.	Yes
return data format	Specifies the data type for the adapter response. Valid values: XML (default), JSON Warning Note If you opt for JSON format, then the headers in adapter response will also be converted to JSON and will be assigned in the output context. Warning Note This parameter is not a part of adapter request XML, it is only used to process adapter response in given format.	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 Add Account operation in JSON format.
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 Account workflow

This operation updates the details of an existing account when there is any change in the values of adapter request.

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
account id	Specifies the unique ID of the account to update. Warning Note The account id of the user can be retrieved by using Get Account operation.	Yes
body parameters	Specifies the body parameters to update the existing account in the vault.	Yes
return data format	Specifies the data type for the adapter response. Valid values: XML (default), JSON Warning Note If you opt for JSON format, then the headers in adapter response will also be converted to JSON and will be assigned in the output context. Warning Note This parameter is not a part of adapter request XML, it is only used to process adapter response in given format.	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.

Delete Account workflow

This operation deletes a specific account in the vault.

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
account id	Specifies the unique ID of the account to delete. Warning Note The account id of the user can be retrieved by using Get Account operation.	Yes
return data format	Specifies the data type for the adapter response. Valid values: XML (default), JSON Warning Note If you opt for JSON format, then the headers in adapter response will also be converted to JSON and will be assigned in the output context. Warning Note This parameter is not a part of adapter request XML, it is only used to process adapter response in given format.	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.

Last modified by Shweta Hardikar on 2019/12/16 00:54

Was this page helpful? Submitting... Thank you

‹ Safe Members workflows Dell Advanced Infrastructure Manager ada... ›

© Copyright 2013 - 2021 BMC Software, Inc.

TrueSight Orchestration Content 21.02