Reference documentation and code samples for the Google Cloud Api Hub V1 Client class AuthConfigTemplate.
AuthConfigTemplate represents the authentication template for a plugin.
Generated from protobuf message google.cloud.apihub.v1.Plugin.ConfigTemplate.AuthConfigTemplate
Namespace
Google \ Cloud \ ApiHub \ V1 \ Plugin \ ConfigTemplateMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ supported_auth_types |
array
Required. The list of authentication types supported by the plugin. |
↳ service_account |
Google\Cloud\ApiHub\V1\GoogleServiceAccountConfig
Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account. |
getSupportedAuthTypes
Required. The list of authentication types supported by the plugin.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSupportedAuthTypes
Required. The list of authentication types supported by the plugin.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
Optional. The service account of the plugin hosting service.
This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ApiHub\V1\GoogleServiceAccountConfig|null |
|
hasServiceAccount
clearServiceAccount
setServiceAccount
Optional. The service account of the plugin hosting service.
This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ApiHub\V1\GoogleServiceAccountConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|