Class: Google::Apis::GkehubV1alpha::IdentityServiceSamlConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkehub_v1alpha/classes.rb,
lib/google/apis/gkehub_v1alpha/representations.rb,
lib/google/apis/gkehub_v1alpha/representations.rb

Overview

Configuration for the SAML Auth flow.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ IdentityServiceSamlConfig

Returns a new instance of IdentityServiceSamlConfig.



3347
3348
3349
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3347

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

Instance Attribute Details

#attribute_mapping ⇒ Hash<String,String>

Optional. The mapping of additional user attributes like nickname, birthday and address etc.. key is the name of this additional attribute. value is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, key is "attribute.nickname" and value is "assertion.nickname". Corresponds to the JSON property attributeMapping

Returns:

  • (Hash<String,String>) 


3305
3306
3307
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3305

def attribute_mapping
  @attribute_mapping
end

#group_prefix ⇒ String

Optional. Prefix to prepend to group name. Corresponds to the JSON property groupPrefix

Returns:

  • (String) 


3310
3311
3312
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3310

def group_prefix
  @group_prefix
end

#groups_attribute ⇒ String

Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the group_prefix). Corresponds to the JSON property groupsAttribute

Returns:

  • (String) 


3317
3318
3319
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3317

def groups_attribute
  @groups_attribute
end

#identity_provider_certificates ⇒ Array<String>

Required. The list of IdP certificates to validate the SAML response against. Corresponds to the JSON property identityProviderCertificates

Returns:

  • (Array<String>) 


3322
3323
3324
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3322

def identity_provider_certificates
  @identity_provider_certificates
end

#identity_provider_id ⇒ String

Required. The entity ID of the SAML IdP. Corresponds to the JSON property identityProviderId

Returns:

  • (String) 


3327
3328
3329
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3327

def identity_provider_id
  @identity_provider_id
end

#identity_provider_sso_uri ⇒ String

Required. The URI where the SAML IdP exposes the SSO service. Corresponds to the JSON property identityProviderSsoUri

Returns:

  • (String) 


3332
3333
3334
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3332

def identity_provider_sso_uri
  @identity_provider_sso_uri
end

#user_attribute ⇒ String

Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the user_prefix). Corresponds to the JSON property userAttribute

Returns:

  • (String) 


3340
3341
3342
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3340

def user_attribute
  @user_attribute
end

#user_prefix ⇒ String

Optional. Prefix to prepend to user name. Corresponds to the JSON property userPrefix

Returns:

  • (String) 


3345
3346
3347
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3345

def user_prefix
  @user_prefix
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3352

def update!(**args)
  @attribute_mapping = args[:attribute_mapping] if args.key?(:attribute_mapping)
  @group_prefix = args[:group_prefix] if args.key?(:group_prefix)
  @groups_attribute = args[:groups_attribute] if args.key?(:groups_attribute)
  @identity_provider_certificates = args[:identity_provider_certificates] if args.key?(:identity_provider_certificates)
  @identity_provider_id = args[:identity_provider_id] if args.key?(:identity_provider_id)
  @identity_provider_sso_uri = args[:identity_provider_sso_uri] if args.key?(:identity_provider_sso_uri)
  @user_attribute = args[:user_attribute] if args.key?(:user_attribute)
  @user_prefix = args[:user_prefix] if args.key?(:user_prefix)
end