Class: Google::Apis::IdentitytoolkitV3::IdpConfig

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

Overview

Template for a single idp configuration.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ IdpConfig

Returns a new instance of IdpConfig



1625
1626
1627
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1625

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

Instance Attribute Details

#client_id ⇒ String

OAuth2 client ID. Corresponds to the JSON property clientId

Returns:

  • (String) 


1597
1598
1599
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1597

def client_id
  @client_id
end

#enabled ⇒ Boolean Also known as: enabled?

Whether this IDP is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


1602
1603
1604
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1602

def enabled
  @enabled
end

#experiment_percent ⇒ Fixnum

Percent of users who will be prompted/redirected federated login for this IDP. Corresponds to the JSON property experimentPercent

Returns:

  • (Fixnum) 


1608
1609
1610
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1608

def experiment_percent
  @experiment_percent
end

#provider ⇒ String

OAuth2 provider. Corresponds to the JSON property provider

Returns:

  • (String) 


1613
1614
1615
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1613

def provider
  @provider
end

#secret ⇒ String

OAuth2 client secret. Corresponds to the JSON property secret

Returns:

  • (String) 


1618
1619
1620
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1618

def secret
  @secret
end

#whitelisted_audiences ⇒ Array<String>

Whitelisted client IDs for audience check. Corresponds to the JSON property whitelistedAudiences

Returns:

  • (Array<String>) 


1623
1624
1625
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1623

def whitelisted_audiences
  @whitelisted_audiences
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1630

def update!(**args)
  @client_id = args[:client_id] if args.key?(:client_id)
  @enabled = args[:enabled] if args.key?(:enabled)
  @experiment_percent = args[:experiment_percent] if args.key?(:experiment_percent)
  @provider = args[:provider] if args.key?(:provider)
  @secret = args[:secret] if args.key?(:secret)
  @whitelisted_audiences = args[:whitelisted_audiences] if args.key?(:whitelisted_audiences)
end