Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

googleauth - Class Google::Auth::ExternalAccount::Credentials (v1.15.0)

Reference documentation and code samples for the googleauth class Google::Auth::ExternalAccount::Credentials.

Provides an entrypoint for all Exernal Account credential classes.

Inherits

Object

Methods

.make_creds

def self.make_creds(options = {}) -> Google::Auth::ExternalAccount::AwsCredentials, Google::Auth::ExternalAccount::IdentityPoolCredentials, Google::Auth::ExternalAccount::PluggableAuthCredentials

Create a ExternalAccount::Credentials

Parameter

options (Hash) — Options for creating credentials

Returns

(Google::Auth::ExternalAccount::AwsCredentials, Google::Auth::ExternalAccount::IdentityPoolCredentials, Google::Auth::ExternalAccount::PluggableAuthCredentials) — The appropriate external account credentials based on the credential source

Raises

(Google::Auth::InitializationError) — If the json file is missing, lacks required fields, or does not contain a supported credential source

.read_json_key

def self.read_json_key(json_key_io) -> Hash

Reads the required fields from the JSON.

Parameter

json_key_io (IO) — An IO object containing the JSON key

Returns

(Hash) — The parsed JSON key

Raises

(Google::Auth::InitializationError) — If the JSON is missing required fields

Constants

AWS_SUBJECT_TOKEN_TYPE

value: "urn:ietf:params:aws:token-type:aws4_request".freeze
The subject token type used for AWS external_account credentials.

MISSING_CREDENTIAL_SOURCE

value: "missing credential source for external account".freeze

INVALID_EXTERNAL_ACCOUNT_TYPE

value: "credential source is not supported external account type".freeze