Module Values.LdapServerMetadataOutputSource

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Sourcetype nonrec t = {
  1. hosts : string list option;
    (*

    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

    *)
  2. roleBase : string option;
    (*

    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.

    *)
  3. roleName : string option;
    (*

    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

    *)
  4. roleSearchMatching : string option;
    (*

    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

    *)
  5. roleSearchSubtree : bool option;
    (*

    The directory search scope for the role. If set to true, scope is to search the entire subtree.

    *)
  6. serviceAccountUsername : string option;
    (*

    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.

    *)
  7. userBase : string option;
    (*

    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.

    *)
  8. userRoleName : string option;
    (*

    Specifies the name of the LDAP attribute for the user group membership.

    *)
  9. userSearchMatching : string option;
    (*

    The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

    *)
  10. userSearchSubtree : bool option;
    (*

    The directory search scope for the user. If set to true, scope is to search the entire subtree.

    *)
}
Sourceval make : ?hosts:??? -> ?roleBase:??? -> ?roleName:??? -> ?roleSearchMatching:??? -> ?roleSearchSubtree:??? -> ?serviceAccountUsername:??? -> ?userBase:??? -> ?userRoleName:??? -> ?userSearchMatching:??? -> ?userSearchSubtree:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of bool | `List of [> `String of string ] list | `String of string ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t