Outbound NTLM Auth

The Outbound NTLM Auth policy provides multiple ways to supply or forward Kerberos credentials.

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

Example of a Outbound NTLM Auth policy:

kind: OutboundNTLMAuth
apiVersion: api.webmethods.io/beta
metadata:
  name: OutboundNTLMAuth
  version: 1.0
  namespace: sample  
spec:
        enabled: true
		use_custom_credential:
			username:
			passwrod:
			domain:
		use_incoming_http_credentials: true
		use_transparent_auth: true

To invoke the Outbound NTLM Auth policy, you can specify:

Type Description
kind

OutboundNTLMAuth. 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. Specifies 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.
  • use_custom_credential. Use explicit NTLM credentials to authenticate the outbound request.

    Provide the following details:
    • username. Specify the user name.
    • password. Specify the password of the user.
    • domain. Specify the domain in which the user resides.
  • use_incoming_http_credentials. Specify the NTLM credentials provided in the incoming HTTP request. Set the value to true to enable the policy, and set it to false to disable the policy.
  • use_transparent_auth. Specify the NTLM authentication, where the user credentials are automatically used without prompting. Set the value to true to enable the policy, and set it to false to disable the policy.