Class HttpEndpointApiKeyAuthScopeConfig

Specifies authentication using an API key injected either as a header or query parameter.

  • If authScope = AGENT: The API key is retrieved from OCI Vault using the agent\u2019s identity.
Inheritance
object
HttpEndpointAuthScopeConfig
HttpEndpointApiKeyAuthScopeConfig
Inherited Members
Namespace: Oci.GenerativeaiagentService.Models
Assembly: OCI.DotNetSDK.Generativeaiagent.dll
Syntax
public class HttpEndpointApiKeyAuthScopeConfig : HttpEndpointAuthScopeConfig

Properties

KeyLocation

Declaration
[Required(ErrorMessage = "KeyLocation is required.")]
[JsonProperty(PropertyName = "keyLocation")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HttpEndpointApiKeyAuthScopeConfig.KeyLocationEnum? KeyLocation { get; set; }
Property Value
Type Description
HttpEndpointApiKeyAuthScopeConfig.KeyLocationEnum?

The location of the API key in the request.
Remarks

Required

KeyName

Declaration
[Required(ErrorMessage = "KeyName is required.")]
[JsonProperty(PropertyName = "keyName")]
public string KeyName { get; set; }
Property Value
Type Description
string

The name of the key parameter in the location.
Remarks

Required

VaultSecretId

Declaration
[JsonProperty(PropertyName = "vaultSecretId")]
public string VaultSecretId { get; set; }
Property Value
Type Description
string

The OCID of the vault secret with API key. Required when authScope is AGENT.