Class: Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest

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

Overview

Request message for ExchangeToken.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleIdentityStsV1ExchangeTokenRequest

Returns a new instance of GoogleIdentityStsV1ExchangeTokenRequest.



63
64
65
 
# File 'generated/google/apis/sts_v1/classes.rb', line 63

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

Instance Attribute Details

#grant_type ⇒ String

Required. The grant type. Must be urn:ietf:params:oauth:grant-type:token- exchange, which indicates a token exchange. Corresponds to the JSON property grantType

Returns:

  • (String) 


33
34
35
 
# File 'generated/google/apis/sts_v1/classes.rb', line 33

def grant_type
  @grant_type
end

#options ⇒ String

A set of features that Security Token Service supports, in addition to the standard OAuth 2.0 token exchange, formatted as a serialized JSON object of Options. Corresponds to the JSON property options

Returns:

  • (String) 


40
41
42
 
# File 'generated/google/apis/sts_v1/classes.rb', line 40

def options
  @options
end

#requested_token_type ⇒ String

Required. An identifier for the type of requested security token. Must be urn: ietf:params:oauth:token-type:access_token. Corresponds to the JSON property requestedTokenType

Returns:

  • (String) 


46
47
48
 
# File 'generated/google/apis/sts_v1/classes.rb', line 46

def requested_token_type
  @requested_token_type
end

#subject_token ⇒ String

Required. The input token. You can use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. If an access token already contains security attributes, you cannot apply additional security attributes. Corresponds to the JSON property subjectToken

Returns:

  • (String) 


54
55
56
 
# File 'generated/google/apis/sts_v1/classes.rb', line 54

def subject_token
  @subject_token
end

#subject_token_type ⇒ String

Required. An identifier that indicates the type of the security token in the subject_token parameter. Must be urn:ietf:params:oauth:token-type: access_token. Corresponds to the JSON property subjectTokenType

Returns:

  • (String) 


61
62
63
 
# File 'generated/google/apis/sts_v1/classes.rb', line 61

def subject_token_type
  @subject_token_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



68
69
70
71
72
73
74
 
# File 'generated/google/apis/sts_v1/classes.rb', line 68

def update!(**args)
  @grant_type = args[:grant_type] if args.key?(:grant_type)
  @options = args[:options] if args.key?(:options)
  @requested_token_type = args[:requested_token_type] if args.key?(:requested_token_type)
  @subject_token = args[:subject_token] if args.key?(:subject_token)
  @subject_token_type = args[:subject_token_type] if args.key?(:subject_token_type)
end