public sealed class AuthConfig.Types.ApiKeyConfig : IMessage<AuthConfig.Types.ApiKeyConfig>, IEquatable<AuthConfig.Types.ApiKeyConfig>, IDeepCloneable<AuthConfig.Types.ApiKeyConfig>, IBufferMessage, IMessage
Reference documentation and code samples for the API hub v1 API class AuthConfig.Types.ApiKeyConfig.
Config for authentication with API key.
Implements
IMessageAuthConfigTypesApiKeyConfig, IEquatableAuthConfigTypesApiKeyConfig, IDeepCloneableAuthConfigTypesApiKeyConfig, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ApiKeyConfig()
public ApiKeyConfig()
ApiKeyConfig(ApiKeyConfig)
public ApiKeyConfig(AuthConfig.Types.ApiKeyConfig other)
Parameter | |
---|---|
Name | Description |
other |
AuthConfigTypesApiKeyConfig |
Properties
ApiKey
public Secret ApiKey { get; set; }
Required. The name of the SecretManager secret version resource storing
the API key. Format:
projects/{project}/secrets/{secrete}/versions/{version}
. The
secretmanager.versions.access
permission should be granted to the
service account accessing the secret.
Property Value | |
---|---|
Type | Description |
Secret |
HttpElementLocation
public AuthConfig.Types.ApiKeyConfig.Types.HttpElementLocation HttpElementLocation { get; set; }
Required. The location of the API key. The default value is QUERY.
Property Value | |
---|---|
Type | Description |
AuthConfigTypesApiKeyConfigTypesHttpElementLocation |
Name
public string Name { get; set; }
Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.
Property Value | |
---|---|
Type | Description |
string |