Web Services Connection Profiles

The following topics describe the connection profile parameters for Web Services, Java, and Messaging:

Web Services REST Connection Profile Parameters

The following table describes Web Services REST connection profile parameters.

Parameter

Authentication Type

Description

Authentication Type

N/A

Determines one of the following authentication types:

  • None

  • Basic

  • OAuth2

  • AWS

  • Google

Username

  • Basic

  • OAuth2

Defines the basic authentication username.

Password

  • Basic

  • OAuth2

Defines the basic authentication password.

Use Preemptive Authentication

Basic

Determines whether to use preemptive authentication.

Use Basic Authentication

OAuth2

Determines whether to add basic authentication to the OAuth2 authentication.

OAuth2 API URL

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.

Client ID

OAuth2

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

Client Secret

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.

Content Type

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

Region

AWS

Determines the region where the AWS jobs are located.

eu-west-2

Custom Service Name

AWS

Defines the AWS service that the API accesses.

batch

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.

Access Key

AWS

Defines the AWS account access key.

Secret Key

AWS

Defines the AWS account secret access key.

Authentication Type

Google

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

  • Access Token

  • Identity Token

Service Account Key

Google

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

Web Services SOAP Connection Profile Parameters

The following table describes Web Services SOAP connection profile parameters.

Parameter

Description

Authentication Type

Determines one of the following authentication types:

  • None

  • Basic

Username

Defines the basic authentication username.

Password

Defines the basic authentication password.

Use Preemptive Authentication

Determines whether to use preemptive authentication.