ben.carrasco/prowler
1
0
Fork 0
mirror of https://github.com/prowler-cloud/prowler.git synced 2026-07-23 12:31:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(gcp): update docstring of ADC credentials (#5879)

Browse Source 
Co-authored-by: Sergio Garcia <hello@mistercloudsec.com>
This commit is contained in:
Prowler Bot
2024-11-25 18:54:40 +01:00
committed by GitHub
parent 3ce785a7b4
commit 94b6fbda91
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
prowler/providers/gcp/gcp_provider.py
+6 -6
View File
@@ -417,17 +417,17 @@ class GcpProvider(Provider):
GCPTestConnectionError if an error occurs during the test connection
Usage:
- Using static credentials:
- Using ADC credentials from `/Users/<user>/.config/gcloud/application_default_credentials.json`:
>>> GcpProvider.test_connection(
... client_id="client_id",
... client_secret="client_secret",
... refresh_token="refresh_token"
... )
- Using a credentials file:
- Using a Service Account credentials file path:
>>> GcpProvider.test_connection(
... credentials_file="credentials_file"
... )
- Using a service account to impersonate, authentication is required to impersonate a service account:
- Using ADC credentials with a Service Account to impersonate:
>>> GcpProvider.test_connection(
... client_id="client_id",
... client_secret="client_secret",
@@ -436,7 +436,7 @@ class GcpProvider(Provider):
... )
"""
try:
# Set the GCP credentials using the provided client_id, client_secret and refresh_token
# Set the GCP credentials using the provided client_id, client_secret and refresh_token from ADC
gcp_credentials = None
if any([client_id, client_secret, refresh_token]):
gcp_credentials = GcpProvider.validate_static_arguments(
@@ -738,7 +738,7 @@ class GcpProvider(Provider):
client_id: str = None, client_secret: str = None, refresh_token: str = None
) -> dict:
"""
Validate the static arguments client_id, client_secret and refresh_token
Validate the static arguments client_id, client_secret and refresh_token of ADC credentials
Args:
client_id: str
@@ -749,7 +749,7 @@ class GcpProvider(Provider):
dict
Raises:
GCPStaticCredentialsError if any of the static arguments is missing
GCPStaticCredentialsError if any of the static arguments is missing from the ADC credentials
Usage:
>>> GcpProvider.validate_static_arguments(client_id, client_secret, refresh_token)