mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-04 02:04:06 +00:00
Alan Buscagliaandalejandrobailo
2198ba2d84
Co-authored-by: alejandrobailo <alejandrobailo94@gmail.com>
25 lines
1.3 KiB
JSON
25 lines
1.3 KiB
JSON
{
|
|
"description": "Static OpenAI Administration API credentials.\n\nOne pydantic model per secret type the provider accepts. The docstring\ndocuments the secret type; ``Field(description=...)`` documents each field;\nrequired fields have no default, optional ones use a default. Prowler reads\nthis (via ``OpenAIProvider.get_credentials_schema``) to validate the stored\nsecret and to document its shape.\n\nThe two secret fields are ``organization_id`` and ``platform_api_key``.\n``base_url`` is an optional non-secret override kept here so the credential\nshape stays the single source of truth across the light (API/web) and the\nruntime (worker) sides.",
|
|
"properties": {
|
|
"organization_id": {
|
|
"description": "OpenAI organization ID, e.g. org-xxxxxxxxxxxxxxxx",
|
|
"title": "Organization Id",
|
|
"type": "string"
|
|
},
|
|
"platform_api_key": {
|
|
"description": "OpenAI platform (Administration) API key used to read organization users and admin API keys",
|
|
"title": "Platform Api Key",
|
|
"type": "string"
|
|
},
|
|
"base_url": {
|
|
"default": "https://api.openai.com/v1",
|
|
"description": "OpenAI API base URL (defaults to https://api.openai.com/v1)",
|
|
"title": "Base Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["organization_id", "platform_api_key"],
|
|
"title": "OpenAIStaticCredentials",
|
|
"type": "object"
|
|
}
|