com.google.api.services.iamcredentials.v1.model

Class GenerateIdTokenRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.iamcredentials.v1.model.GenerateIdTokenRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GenerateIdTokenRequest
extends com.google.api.client.json.GenericJson

Model definition for GenerateIdTokenRequest.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the IAM Service Account Credentials API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GenerateIdTokenRequest()

Method Summary

Modifier and Type	Method and Description
GenerateIdTokenRequest	clone()
String	getAudience() Required.
List<String>	getDelegates() The sequence of service accounts in a delegation chain.
Boolean	getIncludeEmail() Include the service account email in the token.
Boolean	getOrganizationNumberIncluded() Include the organization number of the service account in the token.
GenerateIdTokenRequest	set(String fieldName, Object value)
GenerateIdTokenRequest	setAudience(String audience) Required.
GenerateIdTokenRequest	setDelegates(List<String> delegates) The sequence of service accounts in a delegation chain.
GenerateIdTokenRequest	setIncludeEmail(Boolean includeEmail) Include the service account email in the token.
GenerateIdTokenRequest	setOrganizationNumberIncluded(Boolean organizationNumberIncluded) Include the organization number of the service account in the token.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GenerateIdTokenRequest

public GenerateIdTokenRequest()

Method Detail

getAudience

public String getAudience()

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

Returns:

value or null for none

setAudience

public GenerateIdTokenRequest setAudience(String audience)

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

Parameters:

audience - audience or null for none

getDelegates

public List<String> 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.

Returns:

value or null for none

setDelegates

public GenerateIdTokenRequest setDelegates(List<String> delegates)

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.

Parameters:

delegates - delegates or null for none

getIncludeEmail

public Boolean getIncludeEmail()

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

Returns:

value or null for none

setIncludeEmail

public GenerateIdTokenRequest setIncludeEmail(Boolean includeEmail)

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

Parameters:

includeEmail - includeEmail or null for none

getOrganizationNumberIncluded

public Boolean getOrganizationNumberIncluded()

Include the organization number of the service account in the token. If set to `true`, the token will contain a `google.organization_number` claim. The value of the claim will be `null` if the service account isn't associated with an organization.

Returns:

value or null for none

setOrganizationNumberIncluded

public GenerateIdTokenRequest setOrganizationNumberIncluded(Boolean organizationNumberIncluded)

Include the organization number of the service account in the token. If set to `true`, the token will contain a `google.organization_number` claim. The value of the claim will be `null` if the service account isn't associated with an organization.

Parameters:

organizationNumberIncluded - organizationNumberIncluded or null for none

set

public GenerateIdTokenRequest set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GenerateIdTokenRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson