Options
All
  • Public
  • Public/Protected
  • All
Menu

A resolved destination containing information needed to execute requests, such as the system URL.

You can create a destination as a local object when supplying all necessary information, or it could be retrieved from the destination service on SAP Cloud Platform (via DestinationNameAndJwt). When creating a local object representing a destination, you need to supply at least the url and, if required by the target system, valid credentials with username and password.

Hierarchy

  • Destination

Index

Properties

Optional authTokens

authTokens?: null | DestinationAuthToken[]

Authentication tokens returned from destination service on SAP Cloud Platform.

Optional authentication

authentication?: AuthenticationType

Type of authentication to use.

Defaults to NoAuthentication, unless username and password are provided, in which case the default is BasicAuthentication.

Optional certificates

certificates?: DestinationCertificate[]

Array of certificates used for authentication type ClientCertificateAuthentication.

Optional clientId

clientId?: string

Client Id used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

Optional clientSecret

clientSecret?: string

Client Secret used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

Optional cloudConnectorLocationId

cloudConnectorLocationId?: string

Location ID of the Cloud Connector to be used for connection to an On-Premise system. Optional. Corresponds to property "CloudConnectorLocationId" in the additional properties of a destination.

Optional forwardAuthToken

forwardAuthToken?: boolean

If set to true the auth token provided to the request execution is forwarded to the destination target.

Optional headers

headers?: Record<string, any>

Additional headers to be used for calls against the destination, originally defined by URL.headers.<header-name>. The keys of this object denote the names of the headers and the values their values.

Optional isTestDestination

isTestDestination?: boolean

Flag indicating whether the destination is for test purpose. Should be "undefined" or "false" for non-mocked destinations.

Optional isTrustingAllCertificates

isTrustingAllCertificates?: boolean

Flag indicating whether all certificates should be accepted when communicating with the destination. Should not be "true" in production.

Optional keyStoreName

keyStoreName?: string

Name of the key store/certificate to be used for ClientCertificateAuthentication.

Optional keyStorePassword

keyStorePassword?: string

Password of the key store/certificate to be used for ClientCertificateAuthentication.

Optional name

name?: null | string

Name of the destination retrieved from SAP Cloud Platform.

Optional origin

deprecated

Since v1.0.1. Origin of the destination in a multi-tenant setup on SAP Cloud Platform (either from provider or subscriber account), optional.

Optional originalProperties

originalProperties?: {}

Further properties of the destination as defined in destination service on SAP Cloud Platform, possibly empty.

Type declaration

  • [key: string]: any

Optional password

password?: null | string

Password to use for basic authentication, optional if other means of authentication shall be used.

Optional proxyConfiguration

proxyConfiguration?: ProxyConfiguration

ProxyConfiguration for on-premise connectivity and http(s) web proxies. Is present if proxyType of the destination equals "OnPremise" or environment variables [http_proxy] or [https_proxy] are set See ProxyConfiguration.

Optional proxyType

Proxy type to specify whether the target resides on-premise (not used).

Optional queryParameters

queryParameters?: Record<string, any>

Additional query parameters to be used for calls against the destination, originally defined by URL.queries.<query-parameter-name>. The keys of this object denote the names of the query parameters and the values their values.

Optional sapClient

sapClient?: null | string

Client to target in an SAP system, will be added as HTTP header sap-client if set.

Optional systemUser

systemUser?: string

System user to be used for OAuth2SAMLBearerAssertion authentication type.

Optional tokenServicePassword

tokenServicePassword?: string

Password for tokenServiceUser (if required).

Optional tokenServiceUrl

tokenServiceUrl?: string

URL to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

Optional tokenServiceUser

tokenServiceUser?: string

User for basic authentication to OAuth server (if required).

Optional type

type?: "HTTP" | "LDAP" | "MAIL" | "RFC"

The type of the destination, defaults to 'HTTP'. The SAP Cloud SDK only understands destinations of type 'HTTP'.

url

url: string

Base URL for calls to this destination. The URL has to define the protocol, like http:// or https://, and a host. The path for requests against this destination will be appended to the path defined in the URL as a new path segment.

Optional username

username?: null | string

Username to use for basic authentication, optional if other means of authentication shall be used.

Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.