Skip to content

Commit de2b96b

Browse files
authored
chore: clarify IAM auth support in README (#167)
1 parent 2fb1ade commit de2b96b

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,7 @@ connector.connect(
112112
Note: If specifying Private IP, your application must already be in the same VPC network as your Cloud SQL Instance.
113113

114114
### IAM Authentication
115-
Connections using [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-logins) are supported when using the Postgres driver.
116-
This feature is unsupported for other drivers.
115+
Connections using [Automatic IAM database authentication](https://cloud.google.com/sql/docs/postgres/authentication#automatic) are supported when using the Postgres driver. This feature is unsupported for other drivers. If automatic IAM authentication is not supported for your driver, you can use [Manual IAM database authentication](https://cloud.google.com/sql/docs/postgres/authentication#manual) to connect.
117116
First, make sure to [configure your Cloud SQL Instance to allow IAM authentication](https://cloud.google.com/sql/docs/postgres/create-edit-iam-instances#configure-iam-db-instance) and [add an IAM database user](https://cloud.google.com/sql/docs/postgres/create-manage-iam-users#creating-a-database-user).
118117
Now, you can connect using user or service account credentials instead of a password.
119118
In the call to connect, set the `enable_iam_auth` keyword argument to true and `user` to the email address associated with your IAM user.

0 commit comments

Comments
 (0)