Web Services Connection Profiles

The following topics describe connection profiles for web services:

The following table describes the WebServices connection profile parameters.

ConnectionProfile:Web Services REST

Web Services REST jobs enable you to design and execute single REST API calls.

The following examples show how to define a Web Services REST connection profile.

  • This JSON defines a connection profile using basic authentication:

    Copy
    "REST_BASIC_AUTH"
    {
       "Type": "ConnectionProfile:Web Services REST",
       "Description": "",
       "Centralized": true,
       "WebServiceAuthenticationBasic":
       {
          "UsePreemptiveAuth": true,
          "User": "User Name",
          "Password": "Password"
       }
    }
  • This JSON defines a connection profile using OAuth2 authentication:

    Copy
    "REST_OAUTH2"
    {
       "Type": "ConnectionProfile:Web Services REST",
       "Description": "",
       "Centralized": true,
       "WebServiceAuthenticationOauth2"
       {
          "Body"
         [{
             "resource": "2ff814a6-3304-4ab8-85cb-cd0e6f879c1d"
          }],
          "ContentType": "application/x-www-form-urlencoded",
          "ClientId": "7f477fa3-1a1f-4877-ba80-f39bb563f1b5",
          "ClientSecret": "****",
          "ApiUrl": "https://login.microsoftonline.com/tenantId/oauth2/token"
       }
    }
  • This JSON defines a connection profile using AWS authentication:

    Copy
    "REST_AWS": \
    {
       "Type": "ConnectionProfile:Web Services REST",
       "Description": "",
       "Centralized": true,
       "WebServiceAuthenticationAws":
       {
          "CustomServiceName": "batch",
          "Region": "eu-west-2",
          "AuthMethodAccessAndSecretKeys":
          {
             "AccessKey": "MYAWSACCESSKEY1234",
             "SecretAccessKey": "myAwsSecret12345"
          }
       }
    }
  • This JSON defines a connection profile using Google authentication:

    Copy
    "REST_GCP":
    {
       "Type": "ConnectionProfile:Web Services REST",
       "Description": "",
       "Centralized": true,
       "WebServiceAuthenticationGoogle":
       {
          "TokenType": "Access",
          "ServiceAccountKey": "{\"type\":\"service_account\",\"project_id\":\"sso-gcp-dba-ctm1-priv-cc30752\",\"private_key_id\":\"5197d05c5b8212bea944985cec74a34d6c1868aa\",\"private_key\":\"-----BEGIN PRIVATE KEY-----\\nprivate-key\\n-----END PRIVATE KEY-----\\n\",\"client_email\":\bmc-wla-svc-02@sso-gcp-dba-ctm1-priv-cc30752.iam.gserviceaccount.com\,\"client_id\":\"116650586827623521335\",\"auth_uri\":\https://accounts.google.com/o/oauth2/auth\,\"token_uri\":\https://oauth2.googleapis.com/token\,  \"auth_provider_x509_cert_url\":\https://www.googleapis.com/oauth2/v1/certs\,\"client_x509_cert_url\":\https://www.googleapis.com/robot/v1/metadata/x509/bmc-wla-svc-02%40sso-gcp-dba-ctm1-priv-cc30752.iam.gserviceaccount.com\}"
       }
    }

The following table describes the Web Services REST connection profile parameters.

Parameter

Authentication Type

Description

UsePreemptiveAuth

Basic

Determines whether to use preemptive authentication.

Valid Values:

  • True

  • False

Default: False

User

  • Basic

  • OAuth2

Defines the basic authentication username.

Password

  • Basic

  • OAuth2

Defines the basic authentication password.

Use Basic Authentication

OAuth2

Determines whether to add basic authentication to the OAuth2 authentication.

ApiUrl

OAuth2

Defines the OAuth2 web service URL.

Grant Type

OAuth2

Determines one of the following OAuth2 grant types, which determine how Web Services REST communicates with the OAuth2 web service:

  • Client Credentials: Requests a username and password.

  • Password: Requests an additional access token username and password, which provides additional security.

ClientID

OAuth2

Defines the user ID associated with the Web Services REST user and application.

ClientSecret

OAuth2

Defines the secret (password) associated with the Web Services REST user and application.

Username

OAuth2

Defines an additional grant type username.

Password

OAuth2

Defines an additional grant type password.

ContentType

OAuth2

Defines the content type.

application/x-www-form-urlencoded

Headers

OAuth2

(Optional) Defines the following Oauth2 header parameters:

  • Key

  • Value

Body

OAuth2

(Optional) Defines the following Oauth2 body parameters:

  • Key

  • Value

CustomServiceName

AWS

Defines the AWS service that the API accesses.

Region

AWS

Defines the region where the AWS jobs are located.

eu-west-2

Authentication Method

AWS

Determines one of the following authentication methods:

  • IAM Role: Used for services within the AWS infrastructure.

  • Access & Secret Keys: Used for services outside the AWS infrastructure.

IAM Role

AWS

Defines the Identity and Access Management (IAM) role for the AWS connection.

AccessKey

AWS

Defines the AWS account access key.

SecretKey

AWS

Defines the AWS account secret access key.

TokenType

Google

Determines one of the following authentication types for GCP Access Control:

  • Access Token

  • Identity Token

ServiceAccountKey

Google

Defines a service account that is associated with an RSA key pair.

Centralized

All Authentication Types

Determines whether to create a centralized connection profile, which is stored in the Control-M database and is available to all Agents.

You must set this parameter to true.

ConnectionProfile:Web Services SOAP

Web Services SOAP jobs enable you to design and execute single SOAP API calls.

The following examples show how to define a connection profile for a Web Services SOAP job.

  • This JSON defines a connection profile using basic authentication:

    Copy
    "SOAP_BASIC_AUTH":
    {
       "Type": "ConnectionProfile:Web Services SOAP",
       "Description": "",
       "Centralized": true,
       "WebServiceAuthenticationBasic":
       {
          "UsePreemptiveAuth": true,
          "User": "User Name",
          "Password": "Password"
       }
    }
  • This JSON defines a connection profile with no authentication:

    Copy
    "SOAP_NO_AUTH":
    {
       "Type": "ConnectionProfile:Web Services SOAP",
       "Description": "",
       "Centralized": true
    }

The following table describes the WebServices SOAP connection profile parameters.

Parameter

Description

UsePreemptiveAuth

Determines whether to use preemptive authentication.

Valid Values:

  • True

  • False

Default: False

User

Defines the basic authentication username.

Password

Defines the basic authentication password.

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M database and is available to all Agents.

You must set this parameter to true.