TfsAuthentication Class

Represents a client-side authentication mechanism for Team Foundation Server (TFS) that is based on HTTP basic authentication.

Syntax

public sealed class TfsAuthentication : Object, IAuthenticationModule

Remarks

The TfsAuthentication class is used by the .NET Framework to authenticate clients to a Team Foundation Server instance. It implements the IAuthenticationModule interface, which allows it to be registered with the HttpWebRequest.AuthenticationTypes property.

When a HttpWebRequest attempts to connect to a TFS server that requires authentication, the TfsAuthentication module will intercept the request and provide the necessary credentials.

Constructors

TfsAuthentication()

Initializes a new instance of the TfsAuthentication class.

Methods

Properties

Examples

The following example demonstrates how to register the TfsAuthentication module and use it to authenticate with a TFS server.

using System;
using System.Net;
using System.Net.Security;

public class Example
{
    public static void Main(string[] args)
    {
        // Register the TfsAuthentication module
        AuthenticationManager.Register(new TfsAuthentication(), "TFS");

        // Create a new HttpWebRequest
        HttpWebRequest request = (HttpWebRequest)WebRequest.Create("http://your-tfs-server/tfs/DefaultCollection");

        // Set the credentials for the request
        request.Credentials = new NetworkCredential("username", "password");

        // Get the response
        try
        {
            using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())
            {
                Console.WriteLine("Authentication successful!");
            }
        }
        catch (WebException ex)
        {
            Console.WriteLine($"Authentication failed: {ex.Message}");
        }
    }
}

Requirements