Authentication workflows
This topic provides input and output elements for the workflows in the Authentication folder.
CyberArk Logon workflow
This operation authenticates the user credentials to obtain the authorization token, which is used to perform CyberArk administrative operations.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is CyberArk Logon.
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 |
user name | Specifies username of the CyberArk Web SDK user. Authentication is performed using the Web SDK Endpoint URL specified in the adapter configuration. | Yes |
password | Specifies the password that matches the username. Authentication is performed using the Web SDK Endpoint URL specified in the adapter configuration. | Yes |
The following table describes the output elements for the adapter wrapper process.
Output element | Description |
|---|---|
status | Shows the status of the operation. Valid values: success, failure |
status code | Shows a numeric HTTP status code of a response. |
authorization token | Contains the CyberArk authorization token. |
response headers | Contains the response header values, in XML. |
error message | Shows an error message, if the operation fails. |
CyberArk Logoff workflow
This operation invalidates the authorization token.
The process directory for this workflow is BMC-AD-CyberArk:Web_SDK_API:Authentication and the process name is CyberArk Logoff.
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 |
The following table describes the output elements for the adapter wrapper process.
Output element | Description |
|---|---|
status | Shows the status of the operation. Valid values: success, failure |
response body | Contains the data in the adapter response. |
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. |