# Class UsersSource

OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin.UsersSource

Settings for get and create users in Active Directory.

Namespace: [OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin/)

```csharp
public class UsersSource : IEntityConfig
```

## Type Hierarchy

-   UsersSource Current type
    -   Implemented interfaces
        -   [IEntityConfig](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin.Models/IEntityConfig/)

## Constructors

`public UsersSource(string searchBaseDn, string commonNameAttribute, string memberofAttribute, List<string> objectClasses, List<string>? attributes = null, Dictionary<string, AttributeInitializer>? attributeInitializers = null)` 

Create user source instance.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `searchBaseDn` | `String` | Base DN for search entity (user or group). |
| `commonNameAttribute` | `String` | Common name attribute name. |
| `memberofAttribute` | `String` | MemberOf attribute name. |
| `objectClasses` | `List<String>` | Object class names. |
| `attributes` | `List<String>` | Attributes list. |
| `attributeInitializers` | `Dictionary<String, AttributeInitializer>` | Attribute initializers. |

## Properties

`public string SearchBaseDn { get; set; }` 

Base DN for search entity (user or group).

`public string CommonNameAttribute { get; set; }` 

Common name attribute name.

`public string MemberOfAttribute { get; set; }` 

MemberOf attribute name.

`public List<string> ObjectClasses { get; set; }` 

Object class names.

`public Dictionary<string, AttributeInitializer> AttributeInitializers { get; set; }` 

Attribute initializers. Functions that initialize attributes when group is created.

`public List<string> Attributes { get; set; }` 

Attributes list.

`public UsersSource.LoadGroupType LoadGroupMethod { get; set; }` 

Specifies how to load user's group list. Default value is [UsersSource.LoadGroupType.UseMemberOfAttribute](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin/UsersSource.LoadGroupType/).

## Methods

`public static UsersSource ADBaseDn(string baseDn)` 

Creates typical user source for Microsoft Active Directory.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `baseDn` | `String` | Base dn. For example DC=mydomain,DC=com. |

### Returns

| Type | Description |
| --- | --- |
| `UsersSource` | Configured user source. |

`public static UsersSource ADUserDn(string usersDn)` 

Creates typical user source for Microsoft Active Directory.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `usersDn` | `String` | Users dn. For example CN=users,DC=mydomain,DC=com. |

### Returns

| Type | Description |
| --- | --- |
| `UsersSource` | Configured user source. |

`public static UsersSource LDAPBaseDn(string baseDn)` 

Creates typical user source for non Microsoft LDAP connection.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `baseDn` | `String` | Base dn. For example dc=wimpi,dc=net. |

### Returns

| Type | Description |
| --- | --- |
| `UsersSource` | Configured user source. |

`public static UsersSource LDAPUserDn(string usersDn)` 

Creates typical user source for non Microsoft LDAP connection.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `usersDn` | `String` | Users dn. For example ou=users,dc=wimpi,dc=net. |

### Returns

| Type | Description |
| --- | --- |
| `UsersSource` | Configured user source. |

## Fields

`public const string LDAPDefaultSearchFilter = "(objectClass=inetOrgPerson)"` 

Default users search filter for non Microsoft LDAP.

`public const string LDAPDefaultCommonNameAttribute = "cn"` 

Default user common name attribute name for non Microsoft LDAP.

`public const string LDAPDefaultMemberOfAttribute = "memberOf"` 

Default user memberOf attribute name for non Microsoft LDAP.

`public static readonly ImmutableList<string> LDAPDefaultObjectClasses` 

Default user object class names for non Microsoft LDAP.

`public static readonly ImmutableList<string> LDAPDefaultAttributes` 

Default user attributes list for non Microsoft LDAP.

`public static readonly ImmutableDictionary<string, AttributeInitializer> LDAPDefaultAttributeInitializers` 

Default user attribute initializers for non Microsoft LDAP.

`public const string ADDefaultSearchFilter = "(&(objectClass=user)(objectClass=person))"` 

Default users search filter for Microsoft Active Directory.

`public const string ADDefaultCommonNameAttribute = "cn"` 

Default user common name attribute name for Microsoft Active Directory.

`public const string ADDefaultMemberOfAttribute = "memberOf"` 

Default user memberOf attribute name for Microsoft Active Directory.

`public static readonly ImmutableList<string> ADDefaultObjectClasses` 

Default user object class names for Microsoft Active Directory.

`public static readonly ImmutableList<string> ADDefaultAttributes` 

Default user attributes list for Microsoft Active Directory.

`public static readonly ImmutableDictionary<string, AttributeInitializer> ADDefaultAttributeInitializers` 

Default user attribute initializers for Microsoft Active Directory.

## Nested Types

`public enum UsersSource.LoadGroupType` 

[View UsersSource.LoadGroupType](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin/UsersSource.LoadGroupType/)

[Previous LdapImplementation](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin/LdapImplementation/) [Next UsersSource.LoadGroupType](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin/UsersSource.LoadGroupType/)