Class: Google::Apis::GkehubV2alpha::IdentityServiceUserConfig

Inherits:

Object

• Object
• Google::Apis::GkehubV2alpha::IdentityServiceUserConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/gkehub_v2alpha/classes.rb,
lib/google/apis/gkehub_v2alpha/representations.rb,
lib/google/apis/gkehub_v2alpha/representations.rb

Overview

Defines where users exist in the LDAP directory.

Instance Attribute Summary

• #base_dn ⇒ String

  Required.

• #filter ⇒ String

  Optional.

• #id_attribute ⇒ String

  Optional.

• #login_attribute ⇒ String

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ IdentityServiceUserConfig constructor

  A new instance of IdentityServiceUserConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ IdentityServiceUserConfig

Returns a new instance of IdentityServiceUserConfig.

# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 2169

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#base_dn ⇒ String

Required. The location of the subtree in the LDAP directory to search for user entries. Corresponds to the JSON property baseDn

Returns:

• (String)

# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 2140

def base_dn
  @base_dn
end

#filter ⇒ String

Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)". Corresponds to the JSON property filter

Returns:

• (String)

# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 2147

def filter
  @filter
end

#id_attribute ⇒ String

Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to " userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using " userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName". Corresponds to the JSON property idAttribute

Returns:

• (String)

# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 2160

def id_attribute
  @id_attribute
end

#login_attribute ⇒ String

Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName". Corresponds to the JSON property loginAttribute

Returns:

• (String)

# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 2167

def login_attribute
  @login_attribute
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 2174

def update!(**args)
  @base_dn = args[:base_dn] if args.key?(:base_dn)
  @filter = args[:filter] if args.key?(:filter)
  @id_attribute = args[:id_attribute] if args.key?(:id_attribute)
  @login_attribute = args[:login_attribute] if args.key?(:login_attribute)
end