Class: Google::Apis::IamV1::OauthClient

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

Overview

Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OauthClient

Returns a new instance of OauthClient.



1410
1411
1412
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1410

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

Instance Attribute Details

#allowed_grant_types ⇒ Array<String>

Required. The list of OAuth grant types is allowed for the OauthClient. Corresponds to the JSON property allowedGrantTypes

Returns:

  • (Array<String>) 


1346
1347
1348
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1346

def allowed_grant_types
  @allowed_grant_types
end

#allowed_redirect_uris ⇒ Array<String>

Required. The list of redirect uris that is allowed to redirect back when authorization process is completed. Corresponds to the JSON property allowedRedirectUris

Returns:

  • (Array<String>) 


1352
1353
1354
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1352

def allowed_redirect_uris
  @allowed_redirect_uris
end

#allowed_scopes ⇒ Array<String>

Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * https://www.googleapis.com/ auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. Corresponds to the JSON property allowedScopes

Returns:

  • (Array<String>) 


1360
1361
1362
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1360

def allowed_scopes
  @allowed_scopes
end

#client_id ⇒ String

Output only. The system-generated OauthClient id. Corresponds to the JSON property clientId

Returns:

  • (String) 


1365
1366
1367
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1365

def client_id
  @client_id
end

#client_type ⇒ String

Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource. Corresponds to the JSON property clientType

Returns:

  • (String) 


1372
1373
1374
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1372

def client_type
  @client_type
end

#description ⇒ String

Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1378
1379
1380
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1378

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1384
1385
1386
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1384

def disabled
  @disabled
end

#display_name ⇒ String

Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


1391
1392
1393
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1391

def display_name
  @display_name
end

#expire_time ⇒ String

Output only. Time after which the OauthClient will be permanently purged and cannot be recovered. Corresponds to the JSON property expireTime

Returns:

  • (String) 


1397
1398
1399
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1397

def expire_time
  @expire_time
end

#name ⇒ String

Immutable. The resource name of the OauthClient. Format:projects/project/ locations/location/oauthClients/oauth_client`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1403
1404
1405
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1403

def name
  @name
end

#state ⇒ String

Output only. The state of the OauthClient. Corresponds to the JSON property state

Returns:

  • (String) 


1408
1409
1410
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1408

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1415

def update!(**args)
  @allowed_grant_types = args[:allowed_grant_types] if args.key?(:allowed_grant_types)
  @allowed_redirect_uris = args[:allowed_redirect_uris] if args.key?(:allowed_redirect_uris)
  @allowed_scopes = args[:allowed_scopes] if args.key?(:allowed_scopes)
  @client_id = args[:client_id] if args.key?(:client_id)
  @client_type = args[:client_type] if args.key?(:client_type)
  @description = args[:description] if args.key?(:description)
  @disabled = args[:disabled] if args.key?(:disabled)
  @display_name = args[:display_name] if args.key?(:display_name)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
end