CredentialCache.GetCredential Method (Uri, String)


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

Returns the NetworkCredential instance associated with the specified Uniform Resource Identifier (URI) and authentication type.

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

Public Function GetCredential (
	uriPrefix As Uri,
	authType As String
) As NetworkCredential


Type: System.Uri

A Uri that specifies the URI prefix of the resources that the credential grants access to.

Type: System.String

The authentication scheme used by the resource named in uriPrefix.

Return Value

Type: System.Net.NetworkCredential

A NetworkCredential or, if there is no matching credential in the cache, null.

Exception Condition

uriPrefix or authType is null.

The GetCredential(Uri, String) method searches the CredentialCache and returns the NetworkCredential instance for the specified URI and authorization type. If the CredentialCache contains no matching NetworkCredential instance, null is returned.

GetCredential uses the longest matching URI prefix in the cache to determine which set of credentials to return for an authorization type. The following table shows examples.

URI Prefix


Requests for the specific Web page news.htm.

Requests for all content in the portal path, except the page news.htm.

Requests for all resources at, except those in the portal path.

The following code example uses the GetCredential(Uri, String) method to return the NetworkCredential instance associated with the specified URI and authentication type.

Public Shared Sub GetPage(url As String, userName As String, password As String, domainName As String)
        Dim myCredentialCache As New CredentialCache()
        ' Dummy names used as credentials    
        myCredentialCache.Add(New Uri(""), "Basic", New NetworkCredential("user1", "passwd1", "domain1"))
        myCredentialCache.Add(New Uri(""), "Basic", New NetworkCredential("user2", "passwd2", "domain2"))
        myCredentialCache.Add(New Uri(url), "Basic", New NetworkCredential(userName, password, domainName))
        ' Creates a webrequest with the specified url. 
        Dim myWebRequest As WebRequest = WebRequest.Create(url)
        ' Call 'GetCredential' to obtain the credentials specific to our Uri.
        Dim myCredential As NetworkCredential = myCredentialCache.GetCredential(New Uri(url), "Basic")
        myWebRequest.Credentials = myCredential 'Associating only our credentials            
        ' Sends the request and waits for response.
        Dim myWebResponse As WebResponse = myWebRequest.GetResponse()
        ' Process response here.
        Console.WriteLine(ControlChars.Cr + "Response Received.")

    Catch e As WebException
        If Not (e.Response Is Nothing) Then
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occured : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occured : {0}", e.Status)
        End If
    Catch e As Exception
        Console.WriteLine(ControlChars.Cr + "The following exception was raised : {0}", e.Message)
    End Try
End Sub 'GetPage

Public Shared Sub Display(ByVal credential As NetworkCredential)
    Console.WriteLine("The credentials are: ")
    Console.WriteLine(ControlChars.Cr + "Username : {0} ,Password : {1} ,Domain : {2}", credential.UserName, credential.Password, credential.Domain)
End Sub 'Display

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