Outbound Alias

The Outbound Alias policy allows you to reference a pre-configured alias for outbound authentication. The alias typically maps to stored credentials or tokens, helping you manage and reuse authentication data securely across multiple requests.

In API Studio, this policy is identified by the kind Route.

Example of a Outbound Alias policy:

kind: OutboundAlias
apiVersion: api.webmethods.io/beta
metadata:
  name: OutboundAlias
  version: 1.0
  namespace: sample  
spec:
    enabled: true
	alias:
			

To invoke the Outbound Alias policy, you can specify:

Type Description
kind

OutboundAlias. Defines the type of policy that is being configured.

apiVersion Denotes the version of the API in use.
metadata Denotes the metadata or details of the asset type.
It covers this metadata:
  • name. Name of the policy.
  • version. Version of the policy.
  • namespace. Namespace of the policy.
spec

You can configure the following policy specifications:

  • enabled. Specify whether the policy is enabled or disabled. Set the value to true to enable the policy, and set it to false to disable the policy.
  • alias. Specify the name of the pre-configured outbound alias that holds authentication credentials.