Skip to content

Commit 0560e50

Browse files
committed
Updating 3pi documentation
Fixing dead links in workload docs, adds workforce documentation
1 parent 2fc4ef5 commit 0560e50

File tree

1 file changed

+51
-8
lines changed

1 file changed

+51
-8
lines changed

google/doc.go

+51-8
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,70 @@
3636
// Follow the detailed instructions on how to configure Workload Identity Federation
3737
// in various platforms:
3838
//
39-
// Amazon Web Services (AWS): https://cloud.google.com/iam/docs/access-resources-aws
40-
// Microsoft Azure: https://cloud.google.com/iam/docs/access-resources-azure
41-
// OIDC identity provider: https://cloud.google.com/iam/docs/access-resources-oidc
39+
// Amazon Web Services (AWS): https://cloud.google.com/iam/docs/workload-identity-federation-with-other-clouds#aws
40+
// Microsoft Azure: https://cloud.google.com/iam/docs/workload-identity-federation-with-other-clouds#azure
41+
// OIDC identity provider: https://cloud.google.com/iam/docs/workload-identity-federation-with-other-providers#oidc
42+
// SAML identity provider: https://cloud.google.com/iam/docs/workload-identity-federation-with-other-providers#saml
4243
//
4344
// For OIDC and SAML providers, the library can retrieve tokens in three ways:
4445
// from a local file location (file-sourced credentials), from a server
4546
// (URL-sourced credentials), or from a local executable (executable-sourced
4647
// credentials).
4748
// For file-sourced credentials, a background process needs to be continuously
48-
// refreshing the file location with a new OIDC token prior to expiration.
49+
// refreshing the file location with a new OIDC/SAML token prior to expiration.
4950
// For tokens with one hour lifetimes, the token needs to be updated in the file
5051
// every hour. The token can be stored directly as plain text or in JSON format.
5152
// For URL-sourced credentials, a local server needs to host a GET endpoint to
52-
// return the OIDC token. The response can be in plain text or JSON.
53+
// return the OIDC/SAML token. The response can be in plain text or JSON.
5354
// Additional required request headers can also be specified.
5455
// For executable-sourced credentials, an application needs to be available to
55-
// output the OIDC token and other information in a JSON format.
56+
// output the OIDC/SAML token and other information in a JSON format.
5657
// For more information on how these work (and how to implement
5758
// executable-sourced credentials), please check out:
58-
// https://cloud.google.com/iam/docs/using-workload-identity-federation#oidc
59+
// https://cloud.google.com/iam/docs/workload-identity-federation-with-other-providers#create_a_credential_configuration
60+
//
61+
// Note that this library does not perform any validation on the token_url, token_info_url,
62+
// or service_account_impersonation_url fields of the credential configuration.
63+
// It is not recommended to use a credential configuration that you did not generate with
64+
// the gcloud CLI unless you verify that the URL fields point to a googleapis.com domain.
65+
//
66+
// # Workforce Identity Federation
67+
//
68+
// Workforce identity federation lets you use an external identity provider (IdP) to
69+
// authenticate and authorize a workforce—a group of users, such as employees, partners,
70+
// and contractors—using IAM, so that the users can access Google Cloud services.
71+
// Workforce identity federation extends Google Cloud's identity capabilities to support
72+
// syncless, attribute-based single sign on.
73+
//
74+
// With workforce identity federation, your workforce can access Google Cloud resources
75+
// using an external identity provider (IdP) that supports OpenID Connect (OIDC) or
76+
// SAML 2.0 such as Azure Active Directory (Azure AD), Active Directory Federation
77+
// Services (AD FS), Okta, and others.
78+
//
79+
// Follow the detailed instructions on how to configure Workload Identity Federation
80+
// in various platforms:
81+
//
82+
// Azure AD: https://cloud.google.com/iam/docs/workforce-sign-in-azure-ad
83+
// Okta: https://cloud.google.com/iam/docs/workforce-sign-in-okta
84+
// OIDC identity provider: https://cloud.google.com/iam/docs/configuring-workforce-identity-federation#oidc
85+
// SAML 2.0 identity provider: https://cloud.google.com/iam/docs/configuring-workforce-identity-federation#saml
86+
//
87+
// For workforce identity federation, the library can retrieve tokens in three ways:
88+
// from a local file location (file-sourced credentials), from a server
89+
// (URL-sourced credentials), or from a local executable (executable-sourced
90+
// credentials).
91+
// For file-sourced credentials, a background process needs to be continuously
92+
// refreshing the file location with a new OIDC/SAML token prior to expiration.
93+
// For tokens with one hour lifetimes, the token needs to be updated in the file
94+
// every hour. The token can be stored directly as plain text or in JSON format.
95+
// For URL-sourced credentials, a local server needs to host a GET endpoint to
96+
// return the OIDC/SAML token. The response can be in plain text or JSON.
97+
// Additional required request headers can also be specified.
98+
// For executable-sourced credentials, an application needs to be available to
99+
// output the OIDC/SAML token and other information in a JSON format.
100+
// For more information on how these work (and how to implement
101+
// executable-sourced credentials), please check out:
102+
// https://cloud.google.com/iam/docs/workforce-obtaining-short-lived-credentials#generate_a_configuration_file_for_non-interactive_sign-in
59103
//
60104
// Note that this library does not perform any validation on the token_url, token_info_url,
61105
// or service_account_impersonation_url fields of the credential configuration.
@@ -86,5 +130,4 @@
86130
// same as the one obtained from the oauth2.Config returned from ConfigFromJSON or
87131
// JWTConfigFromJSON, but the Credentials may contain additional information
88132
// that is useful is some circumstances.
89-
//
90133
package google // import "golang.org/x/oauth2/google"

0 commit comments

Comments
 (0)