IAMCredentialsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
IAMCredentialsTransport | The transport used by the client instance. |
Methods
IAMCredentialsClient
IAMCredentialsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates 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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
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 |
IAMCredentialsClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
IAMCredentialsClient | 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 |
IAMCredentialsClient | The constructed client. |
generate_access_token
generate_access_token(request: Optional[Union[google.cloud.iam_credentials_v1.types.common.GenerateAccessTokenRequest, dict]] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, scope: Optional[Sequence[str]] = None, lifetime: Optional[google.protobuf.duration_pb2.Duration] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import iam_credentials_v1
def sample_generate_access_token():
# Create a client
client = iam_credentials_v1.IAMCredentialsClient()
# Initialize request argument(s)
request = iam_credentials_v1.GenerateAccessTokenRequest(
name="name_value",
scope=['scope_value_1', 'scope_value_2'],
)
# Make the request
response = client.generate_access_token(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.iam_credentials_v1.types.GenerateAccessTokenRequest, dict]
The request object. |
name |
str
Required. The resource name of the service account for which the credentials are requested, in the following format: |
delegates |
Sequence[str]
The sequence of service accounts in a delegation chain. Each service account must be granted the |
scope |
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 |
lifetime |
google.protobuf.duration_pb2.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 |
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[Union[google.cloud.iam_credentials_v1.types.common.GenerateIdTokenRequest, dict]] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, audience: Optional[str] = None, include_email: Optional[bool] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Generates an OpenID Connect ID token for a service account.
from google.cloud import iam_credentials_v1
def sample_generate_id_token():
# Create a client
client = iam_credentials_v1.IAMCredentialsClient()
# Initialize request argument(s)
request = iam_credentials_v1.GenerateIdTokenRequest(
name="name_value",
audience="audience_value",
)
# Make the request
response = client.generate_id_token(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.iam_credentials_v1.types.GenerateIdTokenRequest, dict]
The request object. |
name |
str
Required. The resource name of the service account for which the credentials are requested, in the following format: |
delegates |
Sequence[str]
The sequence of service accounts in a delegation chain. Each service account must be granted the |
audience |
str
Required. The audience for the token, such as the API or account that this token grants access to. This corresponds to the |
include_email |
bool
Include the service account email in the token. If set to |
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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_service_account_path
parse_service_account_path(path: str)Parses a service_account path into its component segments.
service_account_path
service_account_path(project: str, service_account: str)Returns a fully-qualified service_account string.
sign_blob
sign_blob(request: Optional[Union[google.cloud.iam_credentials_v1.types.common.SignBlobRequest, dict]] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, payload: Optional[bytes] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import iam_credentials_v1
def sample_sign_blob():
# Create a client
client = iam_credentials_v1.IAMCredentialsClient()
# Initialize request argument(s)
request = iam_credentials_v1.SignBlobRequest(
name="name_value",
payload=b'payload_blob',
)
# Make the request
response = client.sign_blob(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.iam_credentials_v1.types.SignBlobRequest, dict]
The request object. |
name |
str
Required. The resource name of the service account for which the credentials are requested, in the following format: |
delegates |
Sequence[str]
The sequence of service accounts in a delegation chain. Each service account must be granted the |
payload |
bytes
Required. The bytes to sign. This corresponds to the |
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[Union[google.cloud.iam_credentials_v1.types.common.SignJwtRequest, dict]] = None, *, name: Optional[str] = None, delegates: Optional[Sequence[str]] = None, payload: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import iam_credentials_v1
def sample_sign_jwt():
# Create a client
client = iam_credentials_v1.IAMCredentialsClient()
# Initialize request argument(s)
request = iam_credentials_v1.SignJwtRequest(
name="name_value",
payload="payload_value",
)
# Make the request
response = client.sign_jwt(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.iam_credentials_v1.types.SignJwtRequest, dict]
The request object. |
name |
str
Required. The resource name of the service account for which the credentials are requested, in the following format: |
delegates |
Sequence[str]
The sequence of service accounts in a delegation chain. Each service account must be granted the |
payload |
str
Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set. This corresponds to the |
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. |