As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

IAMCredentials

class google.cloud.iam_credentials_v1.services.iam_credentials.IAMCredentialsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport] = 'grpc_asyncio', 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>)[source]

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.

Instantiates the iam credentials client.

Parameters

  • 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_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IAMCredentialsAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IAMCredentialsAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IAMCredentialsAsyncClient

async 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]] = ()) → google.cloud.iam_credentials_v1.types.common.GenerateAccessTokenResponse[source]

Generates an OAuth 2.0 access token for a service account.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_credentials_v1

async def sample_generate_access_token():
    # Create a client
    client = iam_credentials_v1.IAMCredentialsAsyncClient()

    # Initialize request argument(s)
    request = iam_credentials_v1.GenerateAccessTokenRequest(
        name="name_value",
        scope=['scope_value1', 'scope_value2'],
    )

    # Make the request
    response = await client.generate_access_token(request=request)

    # Handle the response
    print(response)
Parameters

  • 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: 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 (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 (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 (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 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.

Returns

Return type

google.cloud.iam_credentials_v1.types.GenerateAccessTokenResponse

async 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]] = ()) → google.cloud.iam_credentials_v1.types.common.GenerateIdTokenResponse[source]

Generates an OpenID Connect ID token for a service account.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_credentials_v1

async def sample_generate_id_token():
    # Create a client
    client = iam_credentials_v1.IAMCredentialsAsyncClient()

    # Initialize request argument(s)
    request = iam_credentials_v1.GenerateIdTokenRequest(
        name="name_value",
        audience="audience_value",
    )

    # Make the request
    response = await client.generate_id_token(request=request)

    # Handle the response
    print(response)
Parameters

  • 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: 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 (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.

Returns

Return type

google.cloud.iam_credentials_v1.types.GenerateIdTokenResponse

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_transport_class() → Type[google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_service_account_path(path: str) → Dict[str, str]

Parses a service_account path into its component segments.

static service_account_path(project: str, service_account: str) → str

Returns a fully-qualified service_account string.

async 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]] = ()) → google.cloud.iam_credentials_v1.types.common.SignBlobResponse[source]

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_credentials_v1

async def sample_sign_blob():
    # Create a client
    client = iam_credentials_v1.IAMCredentialsAsyncClient()

    # Initialize request argument(s)
    request = iam_credentials_v1.SignBlobRequest(
        name="name_value",
        payload=b'payload_blob',
    )

    # Make the request
    response = await client.sign_blob(request=request)

    # Handle the response
    print(response)
Parameters

  • 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: 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 (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.

Returns

Return type

google.cloud.iam_credentials_v1.types.SignBlobResponse

async 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]] = ()) → google.cloud.iam_credentials_v1.types.common.SignJwtResponse[source]

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_credentials_v1

async def sample_sign_jwt():
    # Create a client
    client = iam_credentials_v1.IAMCredentialsAsyncClient()

    # Initialize request argument(s)
    request = iam_credentials_v1.SignJwtRequest(
        name="name_value",
        payload="payload_value",
    )

    # Make the request
    response = await client.sign_jwt(request=request)

    # Handle the response
    print(response)
Parameters

  • 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: 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 (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.

Returns

Return type

google.cloud.iam_credentials_v1.types.SignJwtResponse

property transport: google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

IAMCredentialsTransport

class google.cloud.iam_credentials_v1.services.iam_credentials.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>)[source]

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.

Instantiates the iam credentials client.

Parameters

  • 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 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_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • 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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IAMCredentialsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IAMCredentialsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

IAMCredentialsClient

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]] = ()) → google.cloud.iam_credentials_v1.types.common.GenerateAccessTokenResponse[source]

Generates an OAuth 2.0 access token for a service account.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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_value1', 'scope_value2'],
    )

    # Make the request
    response = client.generate_access_token(request=request)

    # Handle the response
    print(response)
Parameters

  • 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: 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 (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 (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 (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 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.

Returns

Return type

google.cloud.iam_credentials_v1.types.GenerateAccessTokenResponse

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]] = ()) → google.cloud.iam_credentials_v1.types.common.GenerateIdTokenResponse[source]

Generates an OpenID Connect ID token for a service account.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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

  • 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: 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 (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.

Returns

Return type

google.cloud.iam_credentials_v1.types.GenerateIdTokenResponse

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

static parse_service_account_path(path: str) → Dict[str, str][source]

Parses a service_account path into its component segments.

static service_account_path(project: str, service_account: str) → str[source]

Returns a fully-qualified service_account string.

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]] = ()) → google.cloud.iam_credentials_v1.types.common.SignBlobResponse[source]

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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

  • 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: 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 (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.

Returns

Return type

google.cloud.iam_credentials_v1.types.SignBlobResponse

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]] = ()) → google.cloud.iam_credentials_v1.types.common.SignJwtResponse[source]

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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

  • 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: 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 (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.

Returns

Return type

google.cloud.iam_credentials_v1.types.SignJwtResponse

property transport: google.cloud.iam_credentials_v1.services.iam_credentials.transports.base.IAMCredentialsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

IAMCredentialsTransport