Documentation

Google_Service_Iam_Resource_ProjectsServiceAccountsKeys extends Google_Service_Resource
in package

The "keys" collection of methods.

Typical usage is: $iamService = new Google_Service_Iam(...); $keys = $iamService->keys;

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.
create()  : Google_Service_Iam_ServiceAccountKey
Creates a ServiceAccountKey. (keys.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Iam_IamEmpty
Deletes a ServiceAccountKey. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key. (keys.delete)
get()  : Google_Service_Iam_ServiceAccountKey
Gets a ServiceAccountKey. (keys.get)
listProjectsServiceAccountsKeys()  : Google_Service_Iam_ListServiceAccountKeysResponse
Lists every ServiceAccountKey for a service account.
upload()  : Google_Service_Iam_ServiceAccountKey
Creates a ServiceAccountKey, using a public key that you provide.
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

create()

Creates a ServiceAccountKey. (keys.create)

public create(string $name, Google_Service_Iam_CreateServiceAccountKeyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Iam_ServiceAccountKey
Parameters
$name : string

Required. The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

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

Optional parameters.

Return values
Google_Service_Iam_ServiceAccountKey

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

delete()

Deletes a ServiceAccountKey. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key. (keys.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Iam_IamEmpty
Parameters
$name : string

Required. The resource name of the service account key in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

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

Optional parameters.

Return values
Google_Service_Iam_IamEmpty

get()

Gets a ServiceAccountKey. (keys.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Iam_ServiceAccountKey
Parameters
$name : string

Required. The resource name of the service account key in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

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

Optional parameters.

Tags
opt_param

string publicKeyType The output format of the public key requested. X509_PEM is the default output format.

Return values
Google_Service_Iam_ServiceAccountKey

listProjectsServiceAccountsKeys()

Lists every ServiceAccountKey for a service account.

public listProjectsServiceAccountsKeys(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Iam_ListServiceAccountKeysResponse

(keys.listProjectsServiceAccountsKeys)

Parameters
$name : string

Required. The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID, will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

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

Optional parameters.

Tags
opt_param

string keyTypes Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned.

Return values
Google_Service_Iam_ListServiceAccountKeysResponse

upload()

Creates a ServiceAccountKey, using a public key that you provide.

public upload(string $name, Google_Service_Iam_UploadServiceAccountKeyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Iam_ServiceAccountKey

(keys.upload)

Parameters
$name : string

The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

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

Optional parameters.

Return values
Google_Service_Iam_ServiceAccountKey

convertToArrayAndStripNulls()

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

Search results