ICredentials Interface


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides the base authentication interface for retrieving credentials for Web client authentication.

Namespace:   System.Net
Assembly:  System (in System.dll)

public interface class ICredentials

System_CAPS_pubmethodGetCredential(Uri^, String^)

Returns a NetworkCredential object that is associated with the specified URI, and authentication type.

The ICredentials interface provides the GetCredential method to objects that supply network credentials to applications.

The following example illustrates how to use the ICredentials interface.

ref class CredentialList: public ICredentials
   ref class CredentialInfo
      Uri^ uriObj;
      String^ authenticationType;
      NetworkCredential^ networkCredentialObj;
      CredentialInfo( Uri^ uriObj, String^ authenticationType, NetworkCredential^ networkCredentialObj )
         this->uriObj = uriObj;
         this->authenticationType = authenticationType;
         this->networkCredentialObj = networkCredentialObj;

   ArrayList^ arrayListObj;

      arrayListObj = gcnew ArrayList;

   void Add( Uri^ uriObj, String^ authenticationType, NetworkCredential^ credential )

      // Add a 'CredentialInfo' object into a list.
      arrayListObj->Add( gcnew CredentialInfo( uriObj,authenticationType,credential ) );

   // Remove the 'CredentialInfo' object from the list that matches to the given 'Uri' and 'AuthenticationType'
   void Remove( Uri^ uriObj, String^ authenticationType )
      for ( int index = 0; index < arrayListObj->Count; index++ )
         CredentialInfo^ credentialInfo = dynamic_cast<CredentialInfo^>(arrayListObj[ index ]);
         if ( uriObj->Equals( credentialInfo->uriObj ) && authenticationType->Equals( credentialInfo->authenticationType ) )
                  arrayListObj->RemoveAt( index );

   virtual NetworkCredential^ GetCredential( Uri^ uriObj, String^ authenticationType )
      for ( int index = 0; index < arrayListObj->Count; index++ )
         CredentialInfo^ credentialInfoObj = dynamic_cast<CredentialInfo^>(arrayListObj[ index ]);
         if ( uriObj->Equals( credentialInfoObj->uriObj ) && authenticationType->Equals( credentialInfoObj->authenticationType ) )
                  return credentialInfoObj->networkCredentialObj;
      return nullptr;

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 3.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top