IAM Service Account Credentials V1 API - Class Google::Iam::Credentials::V1::GenerateIdTokenRequest (v0.3.5)

Reference documentation and code samples for the IAM Service Account Credentials V1 API class Google::Iam::Credentials::V1::GenerateIdTokenRequest.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#audience

def audience() -> ::String
Returns
  • (::String) — Required. The audience for the token, such as the API or account that this token grants access to.

#audience=

def audience=(value) -> ::String
Parameter
  • value (::String) — 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.

#delegates

def delegates() -> ::Array<::String>
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.

#delegates=

def delegates=(value) -> ::Array<::String>
Parameter
  • value (::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.

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.

#include_email

def include_email() -> ::Boolean
Returns
  • (::Boolean) — Include the service account email in the token. If set to true, the token will contain email and email_verified claims.

#include_email=

def include_email=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#name

def name() -> ::String
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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
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.