Skip to content

Commit b44042a

Browse files
ScruffyProdigygopherbot
authored andcommitted
google/google: update documentation for workload identity federation
Including information on executable-sourced credentials Change-Id: I39bcf20ffd1f5a9026d3d18e127411c03021977d GitHub-Last-Rev: d61f2e7 GitHub-Pull-Request: #592 Reviewed-on: https://go-review.googlesource.com/c/oauth2/+/436836 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Leo Siracusa <leosiracusa@google.com> Run-TryBot: Cody Oss <codyoss@google.com> Reviewed-by: Cody Oss <codyoss@google.com> Auto-Submit: Cody Oss <codyoss@google.com>
1 parent f213421 commit b44042a

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

google/doc.go

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,22 @@
4040
// Microsoft Azure: https://cloud.google.com/iam/docs/access-resources-azure
4141
// OIDC identity provider: https://cloud.google.com/iam/docs/access-resources-oidc
4242
//
43-
// For OIDC providers, the library can retrieve OIDC tokens either from a
44-
// local file location (file-sourced credentials) or from a local server
45-
// (URL-sourced credentials).
43+
// For OIDC and SAML providers, the library can retrieve tokens in three ways:
44+
// from a local file location (file-sourced credentials), from a server
45+
// (URL-sourced credentials), or from a local executable (executable-sourced
46+
// credentials).
4647
// For file-sourced credentials, a background process needs to be continuously
4748
// refreshing the file location with a new OIDC token prior to expiration.
4849
// For tokens with one hour lifetimes, the token needs to be updated in the file
4950
// every hour. The token can be stored directly as plain text or in JSON format.
5051
// For URL-sourced credentials, a local server needs to host a GET endpoint to
5152
// return the OIDC token. The response can be in plain text or JSON.
5253
// Additional required request headers can also be specified.
54+
// For executable-sourced credentials, an application needs to be available to
55+
// output the OIDC token and other information in a JSON format.
56+
// For more information on how these work (and how to implement
57+
// executable-sourced credentials), please check out:
58+
// https://cloud.google.com/iam/docs/using-workload-identity-federation#oidc
5359
//
5460
// # Credentials
5561
//

0 commit comments

Comments
 (0)