Class: Google::Apis::GkehubV2alpha::IdentityServiceSamlConfig

Inherits:
Object
  • Object
show all
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

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.



1960
1961
1962
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1960

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>) 


1918
1919
1920
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1918

def attribute_mapping
  @attribute_mapping
end

#group_prefix ⇒ String

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

Returns:

  • (String) 


1923
1924
1925
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1923

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) 


1930
1931
1932
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1930

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>) 


1935
1936
1937
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1935

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) 


1940
1941
1942
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1940

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) 


1945
1946
1947
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1945

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) 


1953
1954
1955
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1953

def user_attribute
  @user_attribute
end

#user_prefix ⇒ String

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

Returns:

  • (String) 


1958
1959
1960
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1958

def user_prefix
  @user_prefix
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
 
# File 'lib/google/apis/gkehub_v2alpha/classes.rb', line 1965

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