Class: Google::Iam::Credentials::V1::GenerateIdTokenRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/iam/credentials/v1/common.rb

Instance Attribute Summary collapse

Instance Attribute Details

#audience ⇒ ::String

Returns Required. The audience for the token, such as the API or account that this token grants access to.

Returns:

  • (::String) —

    Required. The audience for the token, such as the API or account that this token grants access to.



171
172
173
174
 
# File 'proto_docs/google/iam/credentials/v1/common.rb', line 171

class GenerateIdTokenRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#delegates ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



171
172
173
174
 
# File 'proto_docs/google/iam/credentials/v1/common.rb', line 171

class GenerateIdTokenRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_email ⇒ ::Boolean

Returns Include the service account email in the token. If set to true, the token will contain email and email_verified claims.

Returns:

  • (::Boolean) —

    Include the service account email in the token. If set to true, the token will contain email and email_verified claims.



171
172
173
174
 
# File 'proto_docs/google/iam/credentials/v1/common.rb', line 171

class GenerateIdTokenRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

Returns:

  • (::String) —

    Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.



171
172
173
174
 
# File 'proto_docs/google/iam/credentials/v1/common.rb', line 171

class GenerateIdTokenRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end