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

Name	Description
None	Not Applicable

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