Google Cloud Iam Credentials V1 Client - Class IAMCredentialsClient (1.1.2)

Version 1.1.2

• 1.2.5 (latest)
• 1.2.4
• 1.1.2
• 1.0.6

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Iam Credentials V1 Client class IAMCredentialsClient.

Service Description: A service account is a special type of Google account that belongs to your application or a virtual machine (VM), instead of to an individual end user.

Your application assumes the identity of the service account to call Google APIs, so that the users aren't directly involved.

Service account credentials are used to temporarily assume the identity of the service account. Supported credential types include OAuth 2.0 access tokens, OpenID Connect ID tokens, self-signed JSON Web Tokens (JWTs), and more.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Iam\Credentials\V1\IAMCredentialsClient for the stable implementation

Namespace

Google \ Cloud \ Iam \ Credentials \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

generateAccessToken

Generates an OAuth 2.0 access token for a service account.

The async variant is Google\Cloud\Iam\Credentials\V1\Client\IAMCredentialsClient::generateAccessTokenAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\GenerateAccessTokenRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\Credentials\V1\GenerateAccessTokenResponse

generateIdToken

Generates an OpenID Connect ID token for a service account.

The async variant is Google\Cloud\Iam\Credentials\V1\Client\IAMCredentialsClient::generateIdTokenAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\GenerateIdTokenRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\Credentials\V1\GenerateIdTokenResponse

signBlob

Signs a blob using a service account's system-managed private key.

The async variant is Google\Cloud\Iam\Credentials\V1\Client\IAMCredentialsClient::signBlobAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\SignBlobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\Credentials\V1\SignBlobResponse

signJwt

Signs a JWT using a service account's system-managed private key.

The async variant is Google\Cloud\Iam\Credentials\V1\Client\IAMCredentialsClient::signJwtAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\SignJwtRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\Credentials\V1\SignJwtResponse

generateAccessTokenAsync

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\GenerateAccessTokenRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

generateIdTokenAsync

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\GenerateIdTokenRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

signBlobAsync

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\SignBlobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

signJwtAsync

Parameters
Name	Description
request	Google\Cloud\Iam\Credentials\V1\SignJwtRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

static::serviceAccountName

Formats a string containing the fully-qualified path to represent a service_account resource.

Parameters
Name	Description
project	string
serviceAccount	string

Returns
Type	Description
string	The formatted service_account resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• serviceAccount: projects/{project}/serviceAccounts/{service_account}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.