Skip to content

API Library Active Directory

Jump to bottom
Robert Polak edited this page Jul 24, 2019 · 15 revisions

Home / API Library / Active Directory

API Library Active Directory

API Library Active Directory to search User in the configured Domain. The API Library Active Directory Methods list with Parameters, Return examples.

Configuration

Configuration- Details

Configuration of Active Directory variables at App.config.

<configuration>
	<AppSettings>
		<!-- Active Directory - Domain -->
		<add key="API_AD_DOMAIN" value="" />
		<!-- Active Directory - Path -->
		<add key="API_AD_PATH" value="" />
		<!-- Active Directory - Username -->
		<add key="API_AD_USERNAME" value="" />
		<!-- Active Directory - Username -->
		<add key="API_AD_PASSWORD" value="" />
		<!-- Active Directory - Attribute for Username -->
		<add key="API_AD_ATTRIBUTE_USERNAME" value="cn" />
		<!-- Active Directory - Attribute for Email -->
		<add key="API_AD_ATTRIBUTE_EMAIL" value="mail" />
		<!-- Active Directory - Attribute for First Name -->
		<add key="API_AD_ATTRIBUTE_FIRSTNAME" value="givenName" />
		<!-- Active Directory - Attribute for Last Name -->
		<add key="API_AD_ATTRIBUTE_LASTNAME" value="sn" />
	</AppSettings>
</configuration>

Search

Search- Details Search for User at Active Directory in the configured Domain. Returns the Active Directory User.

Method: API.ActiveDirectory.Search

Parameters:

Name Type Default Description
username String username

Return: The Active Directory User or null

IsAuthenticated

IsAuthenticated- Details Checks if the user is authenticated against Active Directory.

Method: API.ActiveDirectory.IsAuthenticated

Parameters: template

Name Type Default Description
userPrincipal String userPrincipal

Return: true or false

Top

Methods
Test
Clone this wiki locally