google.auth.environment_vars module

Environment variables used by google.auth.

PROJECT = 'GOOGLE_CLOUD_PROJECT'

Environment variable defining default project.

This used by google.auth.default() to explicitly set a project ID. This environment variable is also used by the Google Cloud Python Library.

LEGACY_PROJECT = 'GCLOUD_PROJECT'

Previously used environment variable defining the default project.

This environment variable is used instead of the current one in some situations (such as Google App Engine).

GOOGLE_CLOUD_QUOTA_PROJECT = 'GOOGLE_CLOUD_QUOTA_PROJECT'

Environment variable defining the project to be used for quota and billing.

CREDENTIALS = 'GOOGLE_APPLICATION_CREDENTIALS'

Environment variable defining the location of Google application default credentials.

CLOUD_SDK_CONFIG_DIR = 'CLOUDSDK_CONFIG'

Environment variable defines the location of Google Cloud SDK’s config files.

GCE_METADATA_HOST = 'GCE_METADATA_HOST'

port to be used for GCE metadata requests.

This environment variable was originally named GCE_METADATA_ROOT. The system will check this environemnt variable first; should there be no value present, the system will fall back to the old variable.

Type:

Environment variable providing an alternate hostname or host

GCE_METADATA_ROOT = 'GCE_METADATA_ROOT'

Old environment variable for GCE_METADATA_HOST.

GCE_METADATA_IP = 'GCE_METADATA_IP'

port to be used for ip-only GCE metadata requests.

Type:

Environment variable providing an alternate ip

GCE_METADATA_TIMEOUT = 'GCE_METADATA_TIMEOUT'

Environment variable defining the timeout in seconds to wait for the GCE metadata server when detecting the GCE environment.

GCE_METADATA_DETECT_RETRIES = 'GCE_METADATA_DETECT_RETRIES'

Environment variable representing the number of retries that should be attempted on metadata lookup.

NO_GCE_CHECK = 'NO_GCE_CHECK'

Environment variable controlling whether to check if running on GCE or not.

The default value is false. Users have to explicitly set this value to true in order to disable the GCE check.

GCE_METADATA_MTLS_MODE = 'GCE_METADATA_MTLS_MODE'

Environment variable controlling the mTLS behavior for GCE metadata requests.

Can be one of “strict”, “none”, or “default”.

GOOGLE_API_USE_CLIENT_CERTIFICATE = 'GOOGLE_API_USE_CLIENT_CERTIFICATE'

Environment variable controlling whether to use client certificate or not.

The default value is false. Users have to explicitly set this value to true in order to use client certificate to establish a mutual TLS channel.

LEGACY_APPENGINE_RUNTIME = 'APPENGINE_RUNTIME'

Gen1 environment variable defining the App Engine Runtime.

Used to distinguish between GAE gen1 and GAE gen2+.

GOOGLE_AUTH_TRUST_BOUNDARY_ENABLED = 'GOOGLE_AUTH_TRUST_BOUNDARY_ENABLED'

Environment variable controlling whether to enable trust boundary feature. The default value is false. Users have to explicitly set this value to true.

GOOGLE_API_CERTIFICATE_CONFIG = 'GOOGLE_API_CERTIFICATE_CONFIG'

Environment variable defining the location of Google API certificate config file.

CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE = 'CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE'

Environment variable controlling whether to use client certificate or not. This variable is the fallback of GOOGLE_API_USE_CLIENT_CERTIFICATE.

CLOUDSDK_CONTEXT_AWARE_CERTIFICATE_CONFIG_FILE_PATH = 'CLOUDSDK_CONTEXT_AWARE_CERTIFICATE_CONFIG_FILE_PATH'

Environment variable defining the location of Google API certificate config file. This variable is the fallback of GOOGLE_API_CERTIFICATE_CONFIG.

GOOGLE_API_PREVENT_AGENT_TOKEN_SHARING_FOR_GCP_SERVICES = 'GOOGLE_API_PREVENT_AGENT_TOKEN_SHARING_FOR_GCP_SERVICES'

Environment variable to prevent agent token sharing for GCP services.