Google Cloud Iam Credentials V1 Client - Class SignJwtRequest (2.0.0-RC1)

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

Generated from protobuf message google.iam.credentials.v1.SignJwtRequest

Namespace

Google \ Cloud \ Iam \ Credentials \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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.
↳ delegates array

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request. The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.
↳ payload string

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

getName

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDelegates

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDelegates

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPayload

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

Returns
Type Description
string

setPayload

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
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. Please see Google\Cloud\Iam\Credentials\V1\IAMCredentialsClient::serviceAccountName() for help formatting this field.
delegates string[]

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.
payload string

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.
Returns
Type Description
Google\Cloud\Iam\Credentials\V1\SignJwtRequest