Skip to content

CreateExternalProviderRequest

Type: object

Properties

Property Type Required Description
name string Yes
namespace string Yes
displayName string No

Optional human-readable display name (openshift.io/display-name annotation)

description string No

Optional description (openshift.io/description annotation)

endpointUrl string Yes

FQDN of the external provider with no scheme or path (e.g. api.openai.com)

Constraints: minimum length 1; maximum length 253; pattern ^[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)+$

authMechanism string Yes

Allowed values: apikey, sigv4, oauth2

credentialSecretRef string Yes
provider string Yes
config map of string No

Optional provider-specific configuration key-value pairs (spec.config)

Example

{
  "name": "string",
  "namespace": "string",
  "displayName": "string",
  "description": "string",
  "endpointUrl": "string",
  "authMechanism": "apikey",
  "credentialSecretRef": "string",
  "provider": "string",
  "config": {
    "key": "string"
  }
}