Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

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

Overview

Configuration options for authenticating with an OAuth IDP.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig

Returns a new instance of GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig.



1021
1022
1023
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1021

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

Instance Attribute Details

#client_id ⇒ String

The client id of an OAuth client. Corresponds to the JSON property clientId

Returns:

  • (String) 


983
984
985
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 983

def client_id
  @client_id
end

#client_secret ⇒ String

The client secret of the OAuth client, to enable OIDC code flow. Corresponds to the JSON property clientSecret

Returns:

  • (String) 


988
989
990
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 988

def client_secret
  @client_secret
end

#display_name ⇒ String

The config's display name set by developers. Corresponds to the JSON property displayName

Returns:

  • (String) 


993
994
995
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 993

def display_name
  @display_name
end

#enabled ⇒ Boolean Also known as: enabled?

True if allows the user to sign in with the provider. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


998
999
1000
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 998

def enabled
  @enabled
end

#issuer ⇒ String

For OIDC Idps, the issuer identifier. Corresponds to the JSON property issuer

Returns:

  • (String) 


1004
1005
1006
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1004

def issuer
  @issuer
end

#name ⇒ String

The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome- project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests. Corresponds to the JSON property name

Returns:

  • (String) 


1010
1011
1012
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1010

def name
  @name
end

#response_type ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2OAuthResponseType

The response type to request for in the OAuth authorization flow. You can set either id_token or code to true, but not both. Setting both types to be simultaneously true (code: true, id_token: true) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. Corresponds to the JSON property responseType

Returns:



1019
1020
1021
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1019

def response_type
  @response_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1026

def update!(**args)
  @client_id = args[:client_id] if args.key?(:client_id)
  @client_secret = args[:client_secret] if args.key?(:client_secret)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enabled = args[:enabled] if args.key?(:enabled)
  @issuer = args[:issuer] if args.key?(:issuer)
  @name = args[:name] if args.key?(:name)
  @response_type = args[:response_type] if args.key?(:response_type)
end