Check Authentication

API Type

Web Services

Description

This call is used to verify whether the specified user is a registered user on the AgilePoint Server.

Syntax

public virtual string CheckAuthenticated()

Parameters

Output

If the user is a registered user, the qualified user name in the format of DomainName\UserName is returned. Otherwise, null is returned.

Example

//This example is for an ASP.net application.//
public static string Connect(
System.Web.SessionState.HttpSessionState session,
System.Net.ICredentials credential, string appName, string locale)
    {
    string url = System.Configuration.ConfigurationManager.AppSettings.Get("ServerUrl");
       
    WorkflowService svc = new WorkflowService(url);
    AdminService adm = new AdminService(url);
    System.Net.CookieContainer cookieContainer = new
    System.Net.CookieContainer();
    svc.Credentials = credential;
    svc.CookieContainer = cookieContainer;
    svc.SetClientAppName(appName);
    svc.SetClientLocale(locale);
    string userName = svc.CheckAuthenticated();
    adm.Credentials = credential;
    adm.CookieContainer = cookieContainer;
    adm.SetClientAppName(appName);
    adm.SetClientLocale(locale);

    //Assume the ASP.net is on session
    WFCommonPage.SetAdm(session, adm);
    WFCommonPage.SetAPI(session, api);

    //return fully qualified Domain username
    return userName;
    }

Supported Versions

3.2.0.4 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

• AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
• Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
• Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.