Class IAMCredentialsClient (2.0.0)

IAMCredentialsClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-iam/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

A service account is a special type of Google account that belongs to your application or a virtual machine (VM), instead of to an individual end user. Your application assumes the identity of the service account to call Google APIs, so that the users aren't directly involved.

Service account credentials are used to temporarily assume the identity of the service account. Supported credential types include OAuth 2.0 access tokens, OpenID Connect ID tokens, self- signed JSON Web Tokens (JWTs), and more.

Methods

IAMCredentialsClient

IAMCredentialsClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-iam/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the iam credentials client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .IAMCredentialsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

generate_access_token

generate_access_token(request: Optional[google.cloud.iam_credentials_v1.types.common.GenerateAccessTokenRequest] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, scope: Optional[Sequence[str]] = None, lifetime: Optional[google.protobuf.duration_pb2.Duration] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Generates an OAuth 2.0 access token for a service account.

Parameters
Name	Description
`request`	`.common.GenerateAccessTokenRequest` The request object.
`name`	`str` 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. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`delegates`	`:class:Sequence[str]` 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. This corresponds to the `delegates` field on the `request` instance; if `request` is provided, this should not be set.
`scope`	`:class:Sequence[str]` 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. This corresponds to the `scope` field on the `request` instance; if `request` is provided, this should not be set.
`lifetime`	`.duration.Duration` The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour. This corresponds to the `lifetime` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

generate_id_token

generate_id_token(request: Optional[google.cloud.iam_credentials_v1.types.common.GenerateIdTokenRequest] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, audience: Optional[str] = None, include_email: Optional[bool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Generates an OpenID Connect ID token for a service account.

Parameters
Name	Description
`request`	`.common.GenerateIdTokenRequest` The request object.
`name`	`str` 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. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`delegates`	`:class:Sequence[str]` 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. This corresponds to the `delegates` field on the `request` instance; if `request` is provided, this should not be set.
`audience`	`str` Required. The audience for the token, such as the API or account that this token grants access to. This corresponds to the `audience` field on the `request` instance; if `request` is provided, this should not be set.
`include_email`	`bool` Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims. This corresponds to the `include_email` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

sign_blob

sign_blob(request: Optional[google.cloud.iam_credentials_v1.types.common.SignBlobRequest] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, payload: Optional[bytes] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Signs a blob using a service account's system-managed private key.

Parameters
Name	Description
`request`	`.common.SignBlobRequest` The request object.
`name`	`str` 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. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`delegates`	`:class:Sequence[str]` 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. This corresponds to the `delegates` field on the `request` instance; if `request` is provided, this should not be set.
`payload`	`bytes` Required. The bytes to sign. This corresponds to the `payload` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

sign_jwt

sign_jwt(request: Optional[google.cloud.iam_credentials_v1.types.common.SignJwtRequest] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, payload: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Signs a JWT using a service account's system-managed private key.

Parameters
Name	Description
`request`	`.common.SignJwtRequest` The request object.
`name`	`str` 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. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`delegates`	`:class:Sequence[str]` 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. This corresponds to the `delegates` field on the `request` instance; if `request` is provided, this should not be set.
`payload`	`str` Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set. This corresponds to the `payload` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.