Package com.sap.cloud.sdk.cloudplatform.connectivity

Class BtpServiceOptions.IasOptions

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.BtpServiceOptions.IasOptions

Enclosing class:

BtpServiceOptions

public static final class BtpServiceOptions.IasOptions
extends Object

Factory class for Identity Authentication Service (ServiceIdentifier.IDENTITY_AUTHENTICATION) options.

Since:

5.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BtpServiceOptions.IasOptions.IasCommunicationOptions	An ServiceBindingDestinationOptions.OptionsEnhancer that contains the communication options for an IAS-based destination.
static final class	BtpServiceOptions.IasOptions.IasTargetUri	Deprecated. since 5.9.0.
static final class	BtpServiceOptions.IasOptions.NoTokenForTechnicalProviderUser	An ServiceBindingDestinationOptions.OptionsEnhancer that indicates whether no token is required for authenticating at the target system iff the authentication happens on behalf of a technical provider user.
static final class	BtpServiceOptions.IasOptions.TokenFormat	An ServiceBindingDestinationOptions.OptionsEnhancer that specifies the token format for IAS token requests.

Method Summary

Modifier and Type	Method	Description
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withApplicationName(String applicationName)	Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given "Dependency Name" when performing token retrievals.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withConsumerClient(String consumerClientId)	Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given consumer client ID when performing token retrievals.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withConsumerClient(String consumerClientId, String consumerTenantId)	Deprecated. since 5.10.0.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withoutTokenForTechnicalProviderUser()	Creates an instance of BtpServiceOptions.IasOptions.NoTokenForTechnicalProviderUser.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withProviderClient(String providerClientId)	Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given provider client ID when performing token retrievals.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withProviderClient(String providerClientId, String providerTenantId)	Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given provider client ID and provider tenant ID when performing token retrievals.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withTargetUri(String targetUri)	Deprecated. since 5.9.0.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withTargetUri(URI targetUri)	Deprecated. since 5.9.0.
static ServiceBindingDestinationOptions.OptionsEnhancer<?>	withTokenFormat(String format)	Specifies the token format to request from IAS during token exchange.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withTargetUri

@Nonnull
@Deprecated
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withTargetUri(@Nonnull
 String targetUri)

Deprecated.

since 5.9.0. Use BtpServiceOptions.AuthenticationServiceOptions.withTargetUri(String) instead.

Overwrites the target URI that is extracted from the IAS service binding.

Parameters:

targetUri - The target URI to be used.

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that is used when creating a destination from an IAS service binding and that contains the target URI.

withTargetUri

@Nonnull
@Deprecated
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withTargetUri(@Nonnull
 URI targetUri)

Deprecated.

since 5.9.0. Use BtpServiceOptions.AuthenticationServiceOptions.withTargetUri(URI) instead.

Overwrites the target URI that is extracted from the IAS service binding.

Parameters:

targetUri - The target URI to be used.

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that is used when creating a destination from an IAS service

withoutTokenForTechnicalProviderUser

@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withoutTokenForTechnicalProviderUser()

Creates an instance of BtpServiceOptions.IasOptions.NoTokenForTechnicalProviderUser.

Returns:

A new BtpServiceOptions.IasOptions.NoTokenForTechnicalProviderUser instance.

withApplicationName

@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withApplicationName(@Nonnull
 String applicationName)

Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given "Dependency Name" when performing token retrievals. This is needed in App-To-App communication scenarios.

Hint: This option is mutually exclusive with withConsumerClient(String).

Parameters:

applicationName - The name of the "Dependency Name" to be used. This is the name that was used to register the dependency to an API of a provider application within the IAS tenant.

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that will lead to the given application provider being used when retrieving an authentication token from the IAS service.

See Also:

• Consuming APIs from Other Applications

withProviderClient

@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withProviderClient(@Nonnull
 String providerClientId)

Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given provider client ID when performing token retrievals. This is needed in App-To-App communication scenarios.

Hint: This option is mutually exclusive with withConsumerClient(String).

Parameters:

providerClientId - Client ID of the provider application

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that will lead to the given application provider being used when retrieving an authentication token from the IAS service.

See Also:

• Consuming APIs from Other Applications

withProviderClient

@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withProviderClient(@Nonnull
 String providerClientId,
 @Nonnull
 String providerTenantId)

Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given provider client ID and provider tenant ID when performing token retrievals. This is needed in App-To-App communication scenarios when having dependencies to different tenants of the same, multi-tenant provider application (fan-out / 1-N).

Hint: This option is mutually exclusive with withConsumerClient(String)

Parameters:

providerClientId - Client ID of the provider application

providerTenantId - Tenant ID of the provider application

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that will lead to the given application provider being used when retrieving an authentication token from the IAS service.

See Also:

• Consuming APIs from Other Applications

withConsumerClient

@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withConsumerClient(@Nonnull
 String consumerClientId)

Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given consumer client ID when performing token retrievals. This is needed in Service-To-App communication scenarios.

Hint: This option is mutually exclusive with withApplicationName(String).

Parameters:

consumerClientId - The client ID of the consumer application. This client ID is usually extracted from an incoming IAS authentication token sent by the consumer application upon calling this application.

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that will lead to the given consumer client ID being used when retrieving an authentication token from the IAS service.

withConsumerClient

@Deprecated
@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withConsumerClient(@Nonnull
 String consumerClientId,
 @Nonnull
 String consumerTenantId)

Deprecated.

since 5.10.0. Use withConsumerClient(String) instead.

Creates an ServiceBindingDestinationOptions.OptionsEnhancer that instructs an IAS-based destination to use the given consumer client and tenant ID when performing token retrievals. This is needed in Service-To-App communication scenarios.

Hint: This option is mutually exclusive with withApplicationName(String).

Parameters:

consumerClientId - The client ID of the consumer application. This client ID is usually extracted from an incoming IAS authentication token sent by the consumer application upon calling this application.

consumerTenantId - The tenant ID of the consumer application. This tenant ID is usually extracted from an incoming IAS authentication token sent by the consumer application upon calling this application.

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer that will lead to the given consumer client ID and tenant ID being used when retrieving an authentication token from the IAS service.

withTokenFormat

@Nonnull
public static ServiceBindingDestinationOptions.OptionsEnhancer<?> withTokenFormat(@Nonnull
 String format)

Specifies the token format to request from IAS during token exchange.

If not specified, the token_format parameter is not included in the token exchange request, and IAS will use its default behavior (SAML). Explicitly set to "jwt" if the target service requires JWT tokens.

Parameters:

format - The token format to request. Typically "jwt" or "saml".

Returns:

An instance of ServiceBindingDestinationOptions.OptionsEnhancer for the token format.