HTTP Auth Method

Defines the base class for HTTP authentication methods used for service-to-service communication in Grooper.

Remarks

The HTTP Auth Method class provides a foundation for implementing various HTTP authentication mechanisms in Grooper, such as Basic, Bearer (OAuth), or custom token-based authentication. This abstraction allows Grooper to support a wide range of external APIs and services that require different authentication schemes.

Overview

When Grooper connects to an external HTTP-based service, it must often include an authentication header in each request. HTTP Auth Method defines the contract for generating this header, ensuring that derived classes can provide the correct credentials or tokens as required by the target service.

Usage

• Do not use HTTP Auth Method directly. Instead, select or implement a specific authentication method (such as Basic, OAuth, or a custom scheme) appropriate for your integration scenario.
• When configuring a connection in Grooper, choose the authentication method that matches the requirements of the external service.
• Derived classes must implement the GetAuthorizationHeader() method to return the correct value for the HTTP Authorization header.

Implementation Notes

• Extend HTTP Auth Method in an Object Library to add support for new authentication protocols as needed.
• Ensure that sensitive credentials (such as passwords or tokens) are handled securely and not exposed in logs or user interfaces.
• The returned header value should be suitable for direct inclusion in the HTTP Authorization header, e.g., Bearer <token> or Basic <base64-credentials>.

For more information on configuring authentication in Grooper, see the documentation for [HTTP Authentication Method] and the specific authentication types available in your environment.

Derived Types

There are 2 implementations of HTTP Auth Method.

Basic	Implements HTTP Basic authentication for service-to-service communication in Grooper.
OAuth Client Credentials	Implements OAuth 2.0 Client Credentials authentication for secure service-to-service HTTP integration in Grooper.

Used By

Web Service