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.


1242
1243
1244
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1242

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

Instance Attribute Details

#client_id ⇒ String

OAuth2 client ID. Corresponds to the JSON property clientId

Returns:

  • (String) 

1214
1215
1216
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1214

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) 

1219
1220
1221
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1219

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) 

1225
1226
1227
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1225

def experiment_percent
  @experiment_percent
end

#provider ⇒ String

OAuth2 provider. Corresponds to the JSON property provider

Returns:

  • (String) 

1230
1231
1232
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1230

def provider
  @provider
end

#secret ⇒ String

OAuth2 client secret. Corresponds to the JSON property secret

Returns:

  • (String) 

1235
1236
1237
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1235

def secret
  @secret
end

#whitelisted_audiences ⇒ Array<String>

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

Returns:

  • (Array<String>) 

1240
1241
1242
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1240

def whitelisted_audiences
  @whitelisted_audiences
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1247

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