Reference documentation and code samples for the Google Cloud Iam Credentials V1 Client class GenerateIdTokenRequest.
Generated from protobuf message google.iam.credentials.v1.GenerateIdTokenRequest
Namespace
Google \ Cloud \ Iam \ Credentials \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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.
↳ delegates
array
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.
↳ audience
string
Required. The audience for the token, such as the API or account that this token grants access to.
↳ include_email
bool
Include the service account email in the token. If set to true
, the token will contain email
and email_verified
claims.
getName
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.
string
setName
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.
var
string
$this
getDelegates
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.
setDelegates
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.
var
string[]
$this
getAudience
Required. The audience for the token, such as the API or account that this token grants access to.
string
setAudience
Required. The audience for the token, such as the API or account that this token grants access to.
var
string
$this
getIncludeEmail
Include the service account email in the token. If set to true
, the
token will contain email
and email_verified
claims.
bool
setIncludeEmail
Include the service account email in the token. If set to true
, the
token will contain email
and email_verified
claims.
var
bool
$this
static::build
name
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. Please see IAMCredentialsClient::serviceAccountName()
for help formatting this field.
delegates
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.
audience
string
Required. The audience for the token, such as the API or account that this token grants access to.
includeEmail
bool
Include the service account email in the token. If set to true
, the
token will contain email
and email_verified
claims.
