IAdmNamespace

The IAdmNamespace interface is designed for locating and connecting to Adaxes services, and for binding to directory objects via a certain Adaxes service.

Inheritance: IUnknown

For details on how to use this interface, see Connecting to Adaxes service.

Methods

  • Method

  • Description

  • GetNearestService()

  • Returns the IAdmService interface that represents the nearest Adaxes service.

  • GetServicesForDomain()

  • Returns the IAdmService interface that represents a collection of Adaxes services available in the domain specified.

  • GetService()

  • Returns the IAdmService interface that represents the Adaxes service installed on the specified host. The method doesn't throw an exception if the Adaxes service is not available.

  • GetServiceDirectly()

  • Returns the IAdmService interface that represents the Adaxes service installed on the specified host. If the Adaxes service is unavailable, the method throws an exception.

  • OpenObject()

  • Binds to a directory object, or an Adaxes-specific object using the supplied credentials.

Properties

Details

GetNearestService()

Returns the IAdmService interface that represents the nearest Adaxes service.

IAdmService GetNearestService(string domainName, 
                              string username, 
                              string password)

Parameters

  • domainName – the name of the AD domain where to search for Adaxes services. The parameter can be null.
  • username – the username of the account, whose credentials will be used to search for Adaxes services. If set to null, the credentials of the currently logged on user will be used.
  • password – the password of the account specified in the username parameter.

Remarks

  • If the domainName parameter is set to null, and the username and password parameters are specified, the method will search for Adaxes services in the domain of the user whose credentials are specified.
  • If all parameters are null, the method will search for Adaxes services in the current Active Directory domain using the credentials of the currently logged on user.
  • If you have multiple Adaxes services that manage the same domain and don't share configuration, you need to explicitly specify which configuration set to use via the DefaultConfigurationSet property.

GetServicesForDomain()

Returns the IAdmServices interface that represents a collection of Adaxes services available in the specified domain.

IAdmServices GetServicesForDomain(string domainName, 
                                  string username, 
                                  string password)

Parameters

  • domainName – the name of the domain for which to list the available Adaxes services.
  • username – the username of the account, whose credentials will be used to search for Adaxes services. If set to null, the credentials of the currently logged on user will be used.
  • password – the password of the account specified in the username parameter.

GetService()

Returns the IAdmService interface that represents the Adaxes service installed on the specified host. The method doesn't throw an exception if the Adaxes service is not available.

IAdmService GetService(string host, 
                       string username, 
                       string password)

Parameters

  • host – an IP address or DNS name of a computer with an installed Adaxes service.
  • username – the username of the account to be used to get information about the Adaxes service. If set to null, the credentials of the currently logged on user will be used.
  • password – the password of the account specified in the username parameter.

GetServiceDirectly()

Returns the IAdmService interface that represents the Adaxes service installed on the specified host. If the Adaxes service is unavailable, the method throws an exception.

IAdmService GetServiceDirectly(string host)

Parameters

  • host – an IP address or DNS host name of a computer with an installed Adaxes service.

Remarks

  • The method succeeds only if the Adaxes service is online and accessible from the client machine.
  • Execution can take several seconds while the method iterates through the list of available channels.

OpenObject()

Binds to a directory object an or Adaxes-specific object using the supplied credentials.

object OpenObject(string host, 
                  string adsPath, 
                  string username, 
                  string password, 
                  int authenticationOptions)

Parameters

  • host – an IP address or a DNS host name of the Adaxes service to connect to. If set to null, automatic service discovery will be performed.
  • adsPath – the ADS path of the directory object to bind to.
  • username –the username of the account whose credentials to use for binding. If set to null, the credentials of the currently logged on user will be used.
  • password – the password of the account specified in the username parameter.
  • authenticationOptions – the authentication options. For more information and a list of allowed values, see ADS_AUTHENTICATION_ENUM.

DefaultConfigurationSet

Gets or sets the ID of the default configuration set. This property is used to resolve ambiguity by forcing the Adaxes ADSI provider to always prefer the specified configuration set among other available sets.

  • Type:
  • string
  • Access:
  • Read/Write

Requirements

Minimum required version: 2009.1

See also

© Softerra 2022. All rights reserved.
Send feedback