{"id":4103,"date":"2006-03-17T08:40:00","date_gmt":"2006-03-17T08:40:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/buckh\/2006\/03\/17\/how-to-get-the-login-dialog-when-using-the-team-foundation-server-api\/"},"modified":"2006-03-17T08:40:00","modified_gmt":"2006-03-17T08:40:00","slug":"how-to-get-the-login-dialog-when-using-the-team-foundation-server-api","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/buckh\/how-to-get-the-login-dialog-when-using-the-team-foundation-server-api\/","title":{"rendered":"How to get the login dialog when using the Team Foundation Server API"},"content":{"rendered":"

Someone asked how to get the login dialog if the user fails to authenticate.  The code to do that is shown below.  I copied the call to the constructor from the basic API example<\/a>, and I’ve added code to create and pass a UICredentialsProvider<\/font> object to the TeamFoundationServer<\/font> constructor.<\/p>\n

Also, I’m now calling EnsureAuthenticated()<\/font>.  The purpose of that call is to make sure that the user is able to authenticate with the server.  If not, the TeamFoundationServer<\/font> object will use the UICredentialsProvider<\/font> to display a login dialog.  If the user authenticates successfully after entering a user name and password, the program will continue execution.  If the user clicks the Cancel button in the login dialog, perhaps after failing to enter a valid user name and password, the EnsureAuthenticated()<\/font> method will throw TeamFoundationServerUnauthorizedException<\/font>.<\/p>\n

If you look at the TeamFoundationServer<\/font> class, you will notice that there are two authentication methods to call: Authenticate()<\/font> and EnsureAuthenticated()<\/font>.  The difference is that Authenticate()<\/font> will always call the server, and EnsureAuthenticated()<\/font> will only call the server if the user has not already authenticated, resulting in no performance penalty for calling it multiple times.<\/p>\n

Only Authenticate()<\/font> and EnsureAuthenticated()<\/font> will display the login dialog.  Any other method calls that fail due to the user not authenticating will result in TeamFoundationServerUnauthorizedException<\/font> being thrown.<\/p>\n

    \/\/ Get a reference to our Team Foundation Server.<\/span> 
    TeamFoundationServer tfs = new<\/span> TeamFoundationServer(tfsName, new UICredentialsProvider());<\/p>\n

    \/\/ Authenticate with the server if we haven’t already (in this example, we haven’t).
    \/\/ If authentication fails, the user will see the login dialog, as a result of
    \/\/ UICredentialsProvider() being specified above.<\/span><\/font>
    tfs.EnsureAuthenticated();<\/font><\/p>\n

[Update 3\/20\/06]  Fixed typo.  Thanks, Tim.<\/p><\/p>\n","protected":false},"excerpt":{"rendered":"

Someone asked how to get the login dialog if the user fails to authenticate.  The code to do that is shown below.  I copied the call to the constructor from the basic API example, and I’ve added code to create and pass a UICredentialsProvider object to the TeamFoundationServer constructor. Also, I’m now calling EnsureAuthenticated().  The […]<\/p>\n","protected":false},"author":94,"featured_media":10268,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[6,8,15],"class_list":["post-4103","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized","tag-source-control","tag-team-foundation","tag-tfs-api"],"acf":[],"blog_post_summary":"

Someone asked how to get the login dialog if the user fails to authenticate.  The code to do that is shown below.  I copied the call to the constructor from the basic API example, and I’ve added code to create and pass a UICredentialsProvider object to the TeamFoundationServer constructor. Also, I’m now calling EnsureAuthenticated().  The […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/4103","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/users\/94"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/comments?post=4103"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/4103\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/media\/10268"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/media?parent=4103"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/categories?post=4103"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/tags?post=4103"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}