Login
Use the Login workflow to obtain an authentication token for running the adapter and module management workflows.
The following table describes the input elements for the Login workflow.
Input elements for the Login workflow
Input element | Type | Description | Required |
|---|---|---|---|
url | String | Specifies the URL to the TrueSight Orchestration peer in the following format: https://<hostname>:<port>/<name of the peer> For example, https://clm-aus-123456:58080/baocdp | Conditional; required if not specified in the module configuration Values specified in the input override the values specified in the module configuration. |
username | String | Specifies the user name to log on to the peer | Conditional; required if the URL is specified in the workflow input |
password | String | Specifies the password that matches the username | Conditional; required if the URL is specified in the workflow input |
The following table describes the output elements for the Login workflow.
Output elements for the Login workflow
Output element | Description |
|---|---|
authentication token | Contains the authentication token required to log on to the API server. By default, the authentication token is valid for 24 hours. Validity of the authentication token is based on the session timeout value defined in Remedy Single Sign-On. Save and reuse the token for adapter and module management workflows. |
status | Indicates whether the workflow is run successfully Valid values: success, failure |
status reason | Indicates the reason for success or failure |
error number | Contains the error information |
remediation message | Contains the resolution in case an error occurs |
The following animated graphic demonstrates how to run the Login workflow by specifying the input elements in the workflow and the authentication token that is generated in the workflow response.
Related topics