Page Comparison

You can now generate and use “Personal Access Token(s)” for Web Services API authentication. Optionally you can also disable the use of Basic Authentication for Web Services via a new Web Service Basic Auth Permitted System Property.

In the user definition if Web Service Access is allowed, the user or an administrator can generate Personal Access Tokensfor API authorization:

If the Expiration is left unspecified, the token never expires.

Once generated a Personal Access Token cannot be viewed again.

• You can now authenticate with a controller Web Service API by specifying the Personal Access Token as a Bearer token on the request Authorization header.

curl -H "Authorization: Bearer ucp_OyGyWb7ujBlTD0VACjUmeRSY5UrG81aRYMIQqeRA" https://localhost:8443/uc/resources/task?taskname=Example

• While it is recommended you use the Authorization header, if required, you can alternatively pass the Personal Access Token using the access_token query parameter.

curl https://localhost:8443/uc/resources/task?access_token=ucp_OyGyWb7ujBlTD0VACjUmeRSY5UrG81aRYMIQqeRA&taskname=Example

• You can manage Personal Access Tokens through a number of new Web Service API endpoints.

  • Create Personal Access Token

  • Revoke Personal Access Token

  • List Personal Access Tokens

  • Optionally list Personal Access Tokens on Read/List User Payloads

Template ID (Sysid) and Template Name have been added as query parameters for the Task List Web Services API.

For example:

<generic-query-filter>
      <name>*</name>
      <templateName>PGP Tasks</templateName>
</generic-query-filter>

A new Web Service API (Advanced List API) end point that returns task instance output along with selected task instance meta data.

This API does not retrieve task instance output, but only returns whatever output is already in the database.

{
      "name": "*",
      "instanceOutputType": "STDOUT",
      "responseFields": "name,businessServices,status,startTime,endTime",
      "updatedTimeType": "today"
 } 

[ {
  "businessServices" : [ "QA_Ops" ],
  "endTime" : "2022-08-10 13:41:20 +0000",
  "name" : "QA_sample",
  "output" : [ {
    "attemptCount" : 1,
    "commandName" : null,
    "outputData" : "[empty]",
    "outputFileName" : null,
    "outputType" : "STDOUT"
  } ],
  "startTime" : "2022-08-10 13:41:20 +0000",
  "status" : "SUCCESS",
  "sysId" : "16601367702211025607OKO044T0DQ84"
}, {
  "businessServices" : [ "QA_Ops" ],
  "endTime" : "2022-08-10 15:58:00 +0000",
  "name" : "TEST : Variable Functions",
  "output" : [ {
    "attemptCount" : 1,
    "commandName" : null,
    "outputData" : "[BusinessService_github_demo.json,Script_dev-uac_compose_file.json,Script_dev-uac_copy_import.json]\n[\n[\n",
    "outputFileName" : null,
    "outputType" : "STDOUT"
  }, {
    "attemptCount" : 2,
    "commandName" : null,
    "outputData" : "[BusinessService_github_demo.json,Script_dev-uac_compose_file.json,Script_dev-uac_copy_import.json]\n[\n[\n",
    "outputFileName" : null,
    "outputType" : "STDOUT"
  } ],
  "startTime" : "2022-08-10 15:57:59 +0000",
  "status" : "FAILED",
  "sysId" : "1660140660404071560E2UHGZ4FUY0SE"
}]