Documentation

Google_Service_IAMCredentials_Resource_ProjectsServiceAccounts extends Google_Service_Resource
in package

The "serviceAccounts" collection of methods.

Typical usage is: $iamcredentialsService = new Google_Service_IAMCredentials(...); $serviceAccounts = $iamcredentialsService->serviceAccounts;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
generateAccessToken()  : Google_Service_IAMCredentials_GenerateAccessTokenResponse
Generates an OAuth 2.0 access token for a service account.
generateIdToken()  : Google_Service_IAMCredentials_GenerateIdTokenResponse
Generates an OpenID Connect ID token for a service account.
signBlob()  : Google_Service_IAMCredentials_SignBlobResponse
Signs a blob using a service account's system-managed private key.
signJwt()  : Google_Service_IAMCredentials_SignJwtResponse
Signs a JWT using a service account's system-managed private key.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

generateAccessToken()

Generates an OAuth 2.0 access token for a service account.

public generateAccessToken(string $name, Google_Service_IAMCredentials_GenerateAccessTokenRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IAMCredentials_GenerateAccessTokenResponse

(serviceAccounts.generateAccessToken)

Parameters
$name : string

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

$postBody : Google_Service_IAMCredentials_GenerateAccessTokenRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_IAMCredentials_GenerateAccessTokenResponse —

generateIdToken()

Generates an OpenID Connect ID token for a service account.

public generateIdToken(string $name, Google_Service_IAMCredentials_GenerateIdTokenRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IAMCredentials_GenerateIdTokenResponse

(serviceAccounts.generateIdToken)

Parameters
$name : string

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

$postBody : Google_Service_IAMCredentials_GenerateIdTokenRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_IAMCredentials_GenerateIdTokenResponse —

signBlob()

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

public signBlob(string $name, Google_Service_IAMCredentials_SignBlobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IAMCredentials_SignBlobResponse

(serviceAccounts.signBlob)

Parameters
$name : string

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

$postBody : Google_Service_IAMCredentials_SignBlobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_IAMCredentials_SignBlobResponse —

signJwt()

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

public signJwt(string $name, Google_Service_IAMCredentials_SignJwtRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IAMCredentials_SignJwtResponse

(serviceAccounts.signJwt)

Parameters
$name : string

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

$postBody : Google_Service_IAMCredentials_SignJwtRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_IAMCredentials_SignJwtResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results