Skip to content

Commit 7e0579f

Browse files
On Demand Rides and Deliveriescopybara-github
authored andcommitted
docs: document that the IAM API must be enabled for certain signers
PiperOrigin-RevId: 469823929
1 parent 174d026 commit 7e0579f

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,16 @@ comes loaded with three predefined Signers which handle the common use cases
101101

102102
Signer | GCP Required | Description
103103
:---------------------------: | :----------: | :---------:
104-
`DefaultServiceAccountSigner` | Yes | Signs tokens with the service account running the application. This signer is typically used to sign `FleetEngineTokenType#SERVER` tokens. The service account <b>MUST</b> have the `iam.serviceAccounts.signBlob` permission in order to use this Signer. This is typically acquired through the `Service Account Token Creator` role.
105-
`ImpersonatedSigner` | Yes | Signs tokens by impersonating a different service account. The account hosting the application <b>MUST</b> have the `iam.serviceAccounts.signBlob` permission. This permission is typically acquired through the `Service Account Token Creator` role.
104+
`DefaultServiceAccountSigner` | Yes | Signs tokens with the service account running the application. This signer is typically used to sign `FleetEngineTokenType#SERVER` tokens. The service account <b>MUST</b> have the `iam.serviceAccounts.signBlob` permission which is typically acquired through the `Service Account Token Creator` role.
105+
`ImpersonatedSigner` | Yes | Signs tokens by impersonating a different service account. The account hosting the application <b>MUST</b> have the `iam.serviceAccounts.signBlob` permission which is typically acquired through the `Service Account Token Creator` role.
106106
`LocalSigner` | No | Signs tokens with a private key file generated by a given service account. **Storing private key files in any form presents a security risk and should be a last resort.**
107107

108108
Note: GCP Required denotes that the Signer works with applications that are
109-
hosted on GCP or are otherwise authenticated with GCP. For more information,
110-
see: https://cloud.google.com/docs/authentication/getting-started.
109+
hosted on GCP or are otherwise authenticated with GCP. To use Signers that
110+
require GCP, the
111+
"[IAM Service Account Credentials API](https://console.cloud.google.com/apis/library/iam.googleapis.com)"
112+
<b>MUST</b> be enabled in your GCP project the For more information, see:
113+
https://cloud.google.com/docs/authentication/getting-started.
111114

112115
## Using the library
113116

0 commit comments

Comments
 (0)