Reference documentation and code samples for the googleauth class Google::Auth::ExternalAccount::IdentityPoolCredentials.
This module handles the retrieval of credentials from Google Cloud by utilizing the any 3PI
provider then exchanging the credentials for a short-lived Google Cloud access token.
(Google::Auth::InitializationError) — If credential_source format is invalid, field_name is missing,
contains ambiguous sources, or is missing required fields
#retrieve_subject_token!
defretrieve_subject_token!()->String
Implementation of BaseCredentials retrieve_subject_token!
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# googleauth - Class Google::Auth::ExternalAccount::IdentityPoolCredentials (v1.15.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.15.0 (latest)](/ruby/docs/reference/googleauth/latest/Google-Auth-ExternalAccount-IdentityPoolCredentials)\n- [1.14.0](/ruby/docs/reference/googleauth/1.14.0/Google-Auth-ExternalAccount-IdentityPoolCredentials)\n- [1.13.1](/ruby/docs/reference/googleauth/1.13.1/Google-Auth-ExternalAccount-IdentityPoolCredentials)\n- [1.12.2](/ruby/docs/reference/googleauth/1.12.2/Google-Auth-ExternalAccount-IdentityPoolCredentials) \nReference documentation and code samples for the googleauth class Google::Auth::ExternalAccount::IdentityPoolCredentials.\n\nThis module handles the retrieval of credentials from Google Cloud by utilizing the any 3PI\nprovider then exchanging the credentials for a short-lived Google Cloud access token. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- [Google::Auth::CredentialsLoader](./Google-Auth-CredentialsLoader) \n\nIncludes\n--------\n\n- [Google::Auth::ExternalAccount::BaseCredentials](./Google-Auth-ExternalAccount-BaseCredentials)\n- [Google::Auth::ExternalAccount::ExternalAccountUtils](./Google-Auth-ExternalAccount-ExternalAccountUtils)\n\nMethods\n-------\n\n### #client_id\n\n def client_id()\n\nWill always be nil, but method still gets used.\n\n### #initialize\n\n def initialize(options = {}) -\u003e IdentityPoolCredentials\n\nInitialize from options map. \n**Parameter**\n\n- **options** (Hash) --- Configuration options \n**Returns**\n\n- ([IdentityPoolCredentials](./Google-Auth-ExternalAccount-IdentityPoolCredentials)) --- a new instance of IdentityPoolCredentials \n**Raises**\n\n- ([Google::Auth::InitializationError](./Google-Auth-InitializationError)) --- If credential_source format is invalid, field_name is missing, contains ambiguous sources, or is missing required fields\n\n### #retrieve_subject_token!\n\n def retrieve_subject_token!() -\u003e String\n\nImplementation of BaseCredentials retrieve_subject_token! \n**Returns**\n\n- (String) --- The subject token \n**Raises**\n\n- ([Google::Auth::CredentialsError](./Google-Auth-CredentialsError)) --- If the token can't be parsed from JSON or is missing"]]
