Documentation
¶
Overview ¶
Package google defines credentials for google cloud services.
Index ¶
- func NewComputeEngineCredentials() credentials.Bundle
- func NewDefaultCredentials() credentials.Bundle
- func NewDefaultCredentialsWithOptions(opts DefaultCredentialsOptions) credentials.Bundle
- func NewServiceAccountIdentityCredentials(ctx context.Context, audience string) (credentials.PerRPCCredentials, error)
- type DefaultCredentialsOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewComputeEngineCredentials ¶ added in v1.20.0
func NewComputeEngineCredentials() credentials.Bundle
NewComputeEngineCredentials returns a credentials bundle that is configured to work with google services. This API must only be used when running on GCE. Authentication configured by this API represents the GCE VM's default service account.
This API is experimental.
func NewDefaultCredentials ¶
func NewDefaultCredentials() credentials.Bundle
NewDefaultCredentials returns a credentials bundle that is configured to work with google services.
This API is experimental.
func NewDefaultCredentialsWithOptions ¶ added in v1.40.1
func NewDefaultCredentialsWithOptions(opts DefaultCredentialsOptions) credentials.Bundle
NewDefaultCredentialsWithOptions returns a credentials bundle that is configured to work with google services.
This API is experimental.
func NewServiceAccountIdentityCredentials ¶ added in v1.83.0
func NewServiceAccountIdentityCredentials(ctx context.Context, audience string) (credentials.PerRPCCredentials, error)
NewServiceAccountIdentityCredentials creates a PerRPCCredentials that authenticates using a GCP Service Account Identity JWT token for the given audience.
This credential fetches the ID token from the GCE metadata server and is only valid for use in environments running on GCP. The ctx and audience parameters cannot be empty.
The credentials object starts asynchronous background token fetches to refresh expired tokens. The provided context propagates cancellation to these background tasks. Users should not pass an RPC-scoped context here, but rather a context that is valid for the entire lifetime of the credentials and should cancel the context when they are done.
Experimental ¶
Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.
Types ¶
type DefaultCredentialsOptions ¶ added in v1.40.1
type DefaultCredentialsOptions struct {
// PerRPCCreds is a per RPC credentials that is passed to a bundle.
PerRPCCreds credentials.PerRPCCredentials
// ALTSPerRPCCreds is a per RPC credentials that, if specified, will
// supercede PerRPCCreds above for and only for ALTS connections.
ALTSPerRPCCreds credentials.PerRPCCredentials
}
DefaultCredentialsOptions constructs options to build DefaultCredentials.