API Reference google_api_iam_credentials v0.12.0
Modules
API client metadata for GoogleApi.IAMCredentials.V1.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.IAMCredentials.V1.
Attributes
-
delegates
(type:list(String.t)
, default:nil
) - The sequence of service accounts in a delegation chain. Each service account must be granted theroles/iam.serviceAccountTokenCreator
role on its next service account in the chain. The last service account in the chain must be granted theroles/iam.serviceAccountTokenCreator
role on the service account that is specified in thename
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. -
lifetime
(type:String.t
, default:nil
) - The desired lifetime duration of the access token in seconds. By default, the maximum allowed value is 1 hour. To set a lifetime of up to 12 hours, you can add the service account as an allowed value in an Organization Policy that enforces theconstraints/iam.allowServiceAccountCredentialLifetimeExtension
constraint. See detailed instructions at https://cloud.google.com/iam/help/credentials/lifetime If a value is not specified, the token's lifetime will be set to a default value of 1 hour. -
scope
(type:list(String.t)
, default:nil
) - Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.
Attributes
-
audience
(type:String.t
, default:nil
) - Required. The audience for the token, such as the API or account that this token grants access to. -
delegates
(type:list(String.t)
, default:nil
) - The sequence of service accounts in a delegation chain. Each service account must be granted theroles/iam.serviceAccountTokenCreator
role on its next service account in the chain. The last service account in the chain must be granted theroles/iam.serviceAccountTokenCreator
role on the service account that is specified in thename
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. -
includeEmail
(type:boolean()
, default:nil
) - Include the service account email in the token. If set totrue
, the token will containemail
andemail_verified
claims.
Attributes
-
delegates
(type:list(String.t)
, default:nil
) - The sequence of service accounts in a delegation chain. Each service account must be granted theroles/iam.serviceAccountTokenCreator
role on its next service account in the chain. The last service account in the chain must be granted theroles/iam.serviceAccountTokenCreator
role on the service account that is specified in thename
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. -
payload
(type:String.t
, default:nil
) - Required. The bytes to sign.
Attributes
-
keyId
(type:String.t
, default:nil
) - The ID of the key used to sign the blob. The key used for signing will remain valid for at least 12 hours after the blob is signed. To verify the signature, you can retrieve the public key in several formats from the following endpoints: - RSA public key wrapped in an X.509 v3 certificate:https://www.googleapis.com/service_accounts/v1/metadata/x509/{ACCOUNT_EMAIL}
- Raw key in JSON format:https://www.googleapis.com/service_accounts/v1/metadata/raw/{ACCOUNT_EMAIL}
- JSON Web Key (JWK):https://www.googleapis.com/service_accounts/v1/metadata/jwk/{ACCOUNT_EMAIL}
-
signedBlob
(type:String.t
, default:nil
) - The signature for the blob. Does not include the original blob. After the key pair referenced by thekey_id
response field expires, Google no longer exposes the public key that can be used to verify the blob. As a result, the receiver can no longer verify the signature.
Attributes
-
delegates
(type:list(String.t)
, default:nil
) - The sequence of service accounts in a delegation chain. Each service account must be granted theroles/iam.serviceAccountTokenCreator
role on its next service account in the chain. The last service account in the chain must be granted theroles/iam.serviceAccountTokenCreator
role on the service account that is specified in thename
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. -
payload
(type:String.t
, default:nil
) - Required. The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example:{"sub": "user@example.com", "iat": 313435}
If the JWT Claims Set contains an expiration time (exp
) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future.
Attributes
-
keyId
(type:String.t
, default:nil
) - The ID of the key used to sign the JWT. The key used for signing will remain valid for at least 12 hours after the JWT is signed. To verify the signature, you can retrieve the public key in several formats from the following endpoints: - RSA public key wrapped in an X.509 v3 certificate:https://www.googleapis.com/service_accounts/v1/metadata/x509/{ACCOUNT_EMAIL}
- Raw key in JSON format:https://www.googleapis.com/service_accounts/v1/metadata/raw/{ACCOUNT_EMAIL}
- JSON Web Key (JWK):https://www.googleapis.com/service_accounts/v1/metadata/jwk/{ACCOUNT_EMAIL}
-
signedJwt
(type:String.t
, default:nil
) - The signed JWT. Contains the automatically generated header; the client-supplied payload; and the signature, which is generated using the key referenced by thekid
field in the header. After the key pair referenced by thekey_id
response field expires, Google no longer exposes the public key that can be used to verify the JWT. As a result, the receiver can no longer verify the signature.