Reference documentation and code samples for the Google Cloud Eventarc V1 Client class OidcToken.
Represents a config used to authenticate with a Google OIDC token using
a GCP service account. Use this authentication method to invoke your
Cloud Run and Cloud Functions destinations or HTTP endpoints that
support Google OIDC.
Generated from protobuf message google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OidcToken
Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.
↳ audience
string
Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.
getServiceAccount
Required. Service account email used to generate the OIDC Token.
The principal who calls this API must have
iam.serviceAccounts.actAs permission in the service account. See
https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common
for more information. Eventarc service agents must have
roles/roles/iam.serviceAccountTokenCreator role to allow the
Pipeline to create OpenID tokens for authenticated requests.
Returns
Type
Description
string
setServiceAccount
Required. Service account email used to generate the OIDC Token.
The principal who calls this API must have
iam.serviceAccounts.actAs permission in the service account. See
https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common
for more information. Eventarc service agents must have
roles/roles/iam.serviceAccountTokenCreator role to allow the
Pipeline to create OpenID tokens for authenticated requests.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAudience
Optional. Audience to be used to generate the OIDC Token. The
audience claim identifies the recipient that the JWT is intended for.
If unspecified, the destination URI will be used.
Returns
Type
Description
string
setAudience
Optional. Audience to be used to generate the OIDC Token. The
audience claim identifies the recipient that the JWT is intended for.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Eventarc V1 Client - Class OidcToken (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-eventarc/latest/V1.Pipeline.Destination.AuthenticationConfig.OidcToken)\n- [2.1.4](/php/docs/reference/cloud-eventarc/2.1.4/V1.Pipeline.Destination.AuthenticationConfig.OidcToken)\n- [2.0.1](/php/docs/reference/cloud-eventarc/2.0.1/V1.Pipeline.Destination.AuthenticationConfig.OidcToken)\n- [1.3.5](/php/docs/reference/cloud-eventarc/1.3.5/V1.Pipeline.Destination.AuthenticationConfig.OidcToken)\n- [1.2.2](/php/docs/reference/cloud-eventarc/1.2.2/V1.Pipeline.Destination.AuthenticationConfig.OidcToken)\n- [1.1.1](/php/docs/reference/cloud-eventarc/1.1.1/V1.Pipeline.Destination.AuthenticationConfig.OidcToken)\n- [1.0.5](/php/docs/reference/cloud-eventarc/1.0.5/V1.Pipeline.Destination.AuthenticationConfig.OidcToken) \nReference documentation and code samples for the Google Cloud Eventarc V1 Client class OidcToken.\n\nRepresents a config used to authenticate with a Google OIDC token using\na GCP service account. Use this authentication method to invoke your\nCloud Run and Cloud Functions destinations or HTTP endpoints that\nsupport Google OIDC.\n\nGenerated from protobuf message `google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OidcToken`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Eventarc \\\\ V1 \\\\ Pipeline \\\\ Destination \\\\ AuthenticationConfig\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getServiceAccount\n\nRequired. Service account email used to generate the OIDC Token.\n\nThe principal who calls this API must have\niam.serviceAccounts.actAs permission in the service account. See\n\u003chttps://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common\u003e\nfor more information. Eventarc service agents must have\nroles/roles/iam.serviceAccountTokenCreator role to allow the\nPipeline to create OpenID tokens for authenticated requests.\n\n### setServiceAccount\n\nRequired. Service account email used to generate the OIDC Token.\n\nThe principal who calls this API must have\niam.serviceAccounts.actAs permission in the service account. See\n\u003chttps://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common\u003e\nfor more information. Eventarc service agents must have\nroles/roles/iam.serviceAccountTokenCreator role to allow the\nPipeline to create OpenID tokens for authenticated requests.\n\n### getAudience\n\nOptional. Audience to be used to generate the OIDC Token. The\naudience claim identifies the recipient that the JWT is intended for.\n\nIf unspecified, the destination URI will be used.\n\n### setAudience\n\nOptional. Audience to be used to generate the OIDC Token. The\naudience claim identifies the recipient that the JWT is intended for.\n\nIf unspecified, the destination URI will be used."]]
