credentials_gce: Get a token for Google Compute Engine

Description Usage Arguments Value See Also Examples

View source: R/credentials_gce.R

Description

Uses the metadata service available on GCE VMs to fetch an access token.

Usage

1
2
3
4
5
credentials_gce(
  scopes = "https://www.googleapis.com/auth/cloud-platform",
  service_account = "default",
  ...
)

Arguments

scopes

A character vector of scopes to request. Pick from those listed at https://developers.google.com/identity/protocols/oauth2/scopes.

For certain token flows, the "https://www.googleapis.com/auth/userinfo.email" scope is unconditionally included. This grants permission to retrieve the email address associated with a token; gargle uses this to index cached OAuth tokens. This grants no permission to view or send email and is generally considered a low-value scope.

service_account

Name of the GCE service account to use.

...

Additional arguments passed to all credential functions.

Value

A GceToken() or NULL.

See Also

https://cloud.google.com/compute/docs/storing-retrieving-metadata

Other credential functions: credentials_app_default(), credentials_byo_oauth2(), credentials_external_account(), credentials_service_account(), credentials_user_oauth2(), token_fetch()

Examples

1
2
3
4
## Not run: 
credentials_gce()

## End(Not run)

gargle documentation built on July 2, 2021, 5:07 p.m.