#[non_exhaustive]
pub struct LdapServerMetadataOutput { pub hosts: Option<Vec<String>>, pub role_base: Option<String>, pub role_name: Option<String>, pub role_search_matching: Option<String>, pub role_search_subtree: Option<bool>, pub service_account_username: Option<String>, pub user_base: Option<String>, pub user_role_name: Option<String>, pub user_search_matching: Option<String>, pub user_search_subtree: Option<bool>, }
Expand description

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

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§hosts: Option<Vec<String>>

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

§role_base: Option<String>

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.

§role_name: Option<String>

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

§role_search_matching: Option<String>

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.

§role_search_subtree: Option<bool>

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

§service_account_username: Option<String>

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.

§user_base: Option<String>

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.

§user_role_name: Option<String>

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

§user_search_matching: Option<String>

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.

§user_search_subtree: Option<bool>

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

Implementations§

source§

impl LdapServerMetadataOutput

source

pub fn hosts(&self) -> Option<&[String]>

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

source

pub fn role_base(&self) -> Option<&str>

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.

source

pub fn role_name(&self) -> Option<&str>

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

source

pub fn role_search_matching(&self) -> Option<&str>

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.

source

pub fn role_search_subtree(&self) -> Option<bool>

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

source

pub fn service_account_username(&self) -> Option<&str>

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.

source

pub fn user_base(&self) -> Option<&str>

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.

source

pub fn user_role_name(&self) -> Option<&str>

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

source

pub fn user_search_matching(&self) -> Option<&str>

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.

source

pub fn user_search_subtree(&self) -> Option<bool>

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

source§

impl LdapServerMetadataOutput

source

pub fn builder() -> LdapServerMetadataOutputBuilder

Creates a new builder-style object to manufacture LdapServerMetadataOutput.

Trait Implementations§

source§

impl Clone for LdapServerMetadataOutput

source§

fn clone(&self) -> LdapServerMetadataOutput

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for LdapServerMetadataOutput

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq<LdapServerMetadataOutput> for LdapServerMetadataOutput

source§

fn eq(&self, other: &LdapServerMetadataOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for LdapServerMetadataOutput

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more