Class: Google::Apis::IamcredentialsV1::GenerateIdTokenRequest
- Inherits:
-
Object
- Object
- Google::Apis::IamcredentialsV1::GenerateIdTokenRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/iamcredentials_v1/classes.rb,
generated/google/apis/iamcredentials_v1/representations.rb,
generated/google/apis/iamcredentials_v1/representations.rb
Instance Attribute Summary collapse
-
#audience ⇒ String
Required.
-
#delegates ⇒ Array<String>
The sequence of service accounts in a delegation chain.
-
#include_email ⇒ Boolean
(also: #include_email?)
Include the service account email in the token.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GenerateIdTokenRequest
constructor
A new instance of GenerateIdTokenRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GenerateIdTokenRequest
Returns a new instance of GenerateIdTokenRequest.
125 126 127 |
# File 'generated/google/apis/iamcredentials_v1/classes.rb', line 125 def initialize(**args) update!(**args) end |
Instance Attribute Details
#audience ⇒ String
Required. The audience for the token, such as the API or account that this
token grants access to.
Corresponds to the JSON property audience
104 105 106 |
# File 'generated/google/apis/iamcredentials_v1/classes.rb', line 104 def audience @audience end |
#delegates ⇒ Array<String>
The sequence of service accounts in a delegation chain. Each service account
must be granted the roles/iam.serviceAccountTokenCreator
role on its next
service account in the chain. The last service account in the chain must be
granted the roles/iam.serviceAccountTokenCreator
role on the service account
that is specified in the name
field of the request. The delegates must have
the following format: projects/-/serviceAccounts/
ACCOUNT_EMAIL_OR_UNIQUEID`.
The
-wildcard character is required; replacing it with a project ID is
invalid.
Corresponds to the JSON property
delegates`
116 117 118 |
# File 'generated/google/apis/iamcredentials_v1/classes.rb', line 116 def delegates @delegates end |
#include_email ⇒ Boolean Also known as: include_email?
Include the service account email in the token. If set to true
, the token
will contain email
and email_verified
claims.
Corresponds to the JSON property includeEmail
122 123 124 |
# File 'generated/google/apis/iamcredentials_v1/classes.rb', line 122 def include_email @include_email end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
130 131 132 133 134 |
# File 'generated/google/apis/iamcredentials_v1/classes.rb', line 130 def update!(**args) @audience = args[:audience] if args.key?(:audience) @delegates = args[:delegates] if args.key?(:delegates) @include_email = args[:include_email] if args.key?(:include_email) end |