1. class
  2. Google
  3. \
  4. Auth
  5. \
  6. Credentials
  7. \
  8. ExternalAccountCredentials

ExternalAccountCredentials

class ExternalAccountCredentials implements FetchAuthTokenInterface, UpdateMetadataInterface, GetQuotaProjectInterface, GetUniverseDomainInterface, ProjectIdProviderInterface (View source)

Traits

UpdateMetadataTrait

Provides shared methods for updating request metadata (request headers).

MetricsTrait

Trait containing helper methods required for enabling observability metrics in the library.

Constants

private EXTERNAL_ACCOUNT_TYPE

private CLOUD_RESOURCE_MANAGER_URL

Properties

static protected string $metricMetadataKey from  MetricsTrait

Methods

static string
getMetricsHeader(string $credType = '', string $authRequestType = '')

No description

from  MetricsTrait
array
applyServiceApiUsageMetrics(array $metadata)

No description

from  MetricsTrait
array
applyTokenEndpointMetrics(array $metadata, string $authRequestType)

No description

from  MetricsTrait
static string
getVersion()

No description

from  MetricsTrait
string
getCredType()

No description

from  MetricsTrait
callable
getUpdateMetadataFunc() deprecated

export a callback function which updates runtime metadata.

from  UpdateMetadataTrait
array
updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null)

Updates metadata with the authorization token.

from  UpdateMetadataTrait
__construct(string|string[] $scope, array $jsonKey)

No description

array
fetchAuthToken(callable $httpHandler = null)

No description

string
getCacheKey()

Get the cache token key for the credentials.

null|array
getLastReceivedToken()

Returns an associative array with the token and expiration time.

string|null
getQuotaProject()

Get the quota project used for this API request

string
getUniverseDomain()

Get the universe domain used for this API request

string|null
getProjectId(callable $httpHandler = null, string $accessToken = null)

Get the project ID.

Details

in MetricsTrait at line 47
static protected string getMetricsHeader(string $credType = '', string $authRequestType = '')

No description

Parameters

string $credType

[Optional] The credential type. Empty value will not add any credential type to the header. Should be one of 'sa', 'jwt', 'imp', 'mds', 'u'.
string $authRequestType

[Optional] The auth request type. Empty value will not add any auth request type to the header. Should be one of 'at', 'it', 'mds'.

Return Value

string

The header value for the observability metrics.

in MetricsTrait at line 72
protected array applyServiceApiUsageMetrics(array $metadata)

No description

Parameters

array $metadata

The metadata to update and return.

Return Value

array

The updated metadata.

in MetricsTrait at line 98
protected array applyTokenEndpointMetrics(array $metadata, string $authRequestType)

No description

Parameters

array $metadata

The metadata to update and return.
string $authRequestType

The auth request type. Possible values are 'at', 'it', 'mds'.

Return Value

array

The updated metadata.

in MetricsTrait at line 107
static protected string getVersion()

No description

Return Value

string

in MetricsTrait at line 116
protected string getCredType()

No description

Return Value

string

in UpdateMetadataTrait at line 37
callable getUpdateMetadataFunc() deprecated

deprecated

export a callback function which updates runtime metadata.

Return Value

callable

updateMetadata function

in UpdateMetadataTrait at line 50
array updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null)

Updates metadata with the authorization token.

Parameters

array $metadata

metadata hashmap
string $authUri

optional auth uri
callable $httpHandler

callback which delivers psr7 request

Return Value

array

updated metadata hashmap

at line 62
__construct(string|string[] $scope, array $jsonKey)

No description

Parameters

string|string[] $scope

The scope of the access request, expressed either as an array or as a space-delimited string.
array $jsonKey

JSON credentials as an associative array.

at line 266
array fetchAuthToken(callable $httpHandler = null)

No description

Parameters

callable $httpHandler

callback which delivers psr7 request

Return Value

array

a hash of auth tokens

at line 286
string getCacheKey()

Get the cache token key for the credentials.

The cache token key format depends on the type of source The format for the cache key one of the following: FetcherCacheKey.Scope.[ServiceAccount].[TokenType].[WorkforcePoolUserProject] FetcherCacheKey.Audience.[ServiceAccount].[TokenType].[WorkforcePoolUserProject]

Return Value

string

a key that may be used to cache the auth token.

at line 300
null|array getLastReceivedToken()

Returns an associative array with the token and expiration time.

Return Value

null|array

{ The last received access token.

@type string $access_token The access token string.
@type int $expires_at The time the token expires as a UNIX timestamp.

}

at line 310
string|null getQuotaProject()

Get the quota project used for this API request

Return Value

string|null

at line 320
string getUniverseDomain()

Get the universe domain used for this API request

Return Value

string

at line 334
string|null getProjectId(callable $httpHandler = null, string $accessToken = null)

Get the project ID.

Parameters

callable $httpHandler

Callback which delivers psr7 request
string $accessToken

The access token to use to sign the blob. If provided, saves a call to the metadata server for a new access token. Defaults to null.

Return Value

string|null