> For the complete documentation index, see [llms.txt](https://docs.kognitos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kognitos.com/guides/api-reference/secrets.md).

# Secrets

Manage secrets, secret backends, OAuth apps and secret types.

## List Backend Types

> Catalog of supported backend types and their configuration shape.\
> UIs render configuration forms from this; new backend types appear\
> here automatically when added on the server.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListBackendTypesResponse":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/components/schemas/v1BackendTypeInfo"}}}},"v1BackendTypeInfo":{"type":"object","properties":{"type_id":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"user_creatable":{"type":"boolean","description":"false for platform-managed defaults — visible for documentation but\nnot user-creatable via the API."},"config_fields":{"type":"array","items":{"$ref":"#/components/schemas/v1FieldSpec"},"description":"Fields under `Backend.config`."},"auth_methods":{"type":"array","items":{"$ref":"#/components/schemas/v1AuthMethodSpec"},"description":"Auth methods this backend supports. UI shows a dropdown."}}},"v1FieldSpec":{"type":"object","properties":{"key":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/v1FieldType"},"required":{"type":"boolean"},"default_value":{"type":"string"},"allowed_values":{"type":"array","items":{"type":"string"},"description":"For FIELD_TYPE_ENUM."}}},"v1FieldType":{"type":"string","enum":["FIELD_TYPE_UNSPECIFIED","FIELD_TYPE_STRING","FIELD_TYPE_INTEGER","FIELD_TYPE_BOOL","FIELD_TYPE_ENUM","FIELD_TYPE_SECRET_REFERENCE"],"default":"FIELD_TYPE_UNSPECIFIED","description":" - FIELD_TYPE_SECRET_REFERENCE: Sensitive: UI masks input. On write, the server stores the value in\na core/v1.Secret and replaces it with a reference object. Never\nechoed on read."},"v1AuthMethodSpec":{"type":"object","properties":{"id":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1FieldSpec"},"description":"Inputs the customer provides when picking this method."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/backendTypes":{"get":{"summary":"List Backend Types","description":"Catalog of supported backend types and their configuration shape.\nUIs render configuration forms from this; new backend types appear\nhere automatically when added on the server.","operationId":"ListBackendTypes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListBackendTypesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"tags":["Secrets"]}}}}
```

## List Backends

> List Backends.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListBackendsResponse":{"type":"object","properties":{"backends":{"type":"array","items":{"$ref":"#/components/schemas/v1Backend"}},"next_page_token":{"type":"string"}}},"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/backends":{"get":{"summary":"List Backends","description":"List Backends.","operationId":"ListBackends","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListBackendsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Create Backend

> Create Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/backends":{"post":{"summary":"Create Backend","description":"Create Backend.","operationId":"CreateBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}},"description":"The backend body. `backend.display_name` is required. `backend.name`,\n`backend.create_time`, `backend.etag`, `backend.status`, and\n`backend.kognitos_managed` are set by the server and ignored on\ninput. The id (trailing segment of `backend.name`) is generated by\nthe server as `<type-prefix>-<random-suffix>` (e.g. `aws-7az92kdr`).","required":true},"tags":["Secrets"]}}}}
```

## Get Backend

> Get Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/backends/{backend_id}":{"get":{"summary":"Get Backend","description":"Get Backend.","operationId":"GetBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Delete Backend

> Delete Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/backends/{backend_id}":{"delete":{"summary":"Delete Backend","description":"Delete Backend.","operationId":"DeleteBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Update Backend

> Update Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/backends/{backend_id}":{"patch":{"summary":"Update Backend","description":"Update Backend.","operationId":"UpdateBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}}}},"required":true},"tags":["Secrets"]}}}}
```

## List O Auth Apps

> List O Auth Apps.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListOAuthAppsResponse":{"type":"object","properties":{"oauth_apps":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthApp"}},"next_page_token":{"type":"string"}}},"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/oauthApps":{"get":{"summary":"List O Auth Apps","description":"List O Auth Apps.","operationId":"ListOAuthApps","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListOAuthAppsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Create O Auth App

> Create O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"OAuthAppServiceCreateOAuthAppBody":{"type":"object","properties":{"name":{"type":"string","description":"Derived from `oauth_app.display_name` when empty."},"oauth_app":{"$ref":"#/components/schemas/v1OAuthApp"}}}}},"paths":{"/api/v1/organizations/{organization_id}/oauthApps":{"post":{"summary":"Create O Auth App","description":"Create O Auth App.","operationId":"CreateOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Empty organization_id creates in the shared tier.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthAppServiceCreateOAuthAppBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Get O Auth App

> Get O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/oauthApps/{oauth_app_id}":{"get":{"summary":"Get O Auth App","description":"Get O Auth App.","operationId":"GetOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"oauth_app_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Delete O Auth App

> Delete O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/oauthApps/{oauth_app_id}":{"delete":{"summary":"Delete O Auth App","description":"Delete O Auth App.","operationId":"DeleteOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"oauth_app_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"purge_credentials","description":"When true, also delete the stored client credentials from the managed\ncredential store. Default leaves them (mirrors `--purge-credentials`\non backends); purge errors are logged, not fatal.","in":"query","required":false,"schema":{"type":"boolean"}}],"tags":["Secrets"]}}}}
```

## Update O Auth App

> Update O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/oauthApps/{oauth_app_id}":{"patch":{"summary":"Update O Auth App","description":"Update O Auth App.","operationId":"UpdateOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"oauth_app_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"update_mask","description":"Updatable: `display_name`, `metadata`, `secret_type`. `secret_type` is\nset-once: resending the current value is a no-op, a different one is\nrejected. Empty ⇒ every populated updatable field (AIP-134), so clearing\n`metadata` requires naming it here.","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}},"description":"`oauth_app.etag`, when set, must match the app's current etag (AIP-154).","required":true},"tags":["Secrets"]}}}}
```

## List Secrets

> List Secrets.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListSecretsResponse":{"type":"object","properties":{"secrets":{"type":"array","items":{"$ref":"#/components/schemas/v1Secret"}},"next_page_token":{"type":"string"}}},"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/secrets":{"get":{"summary":"List Secrets","description":"List Secrets.","operationId":"ListSecrets","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListSecretsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Create Secret

> Create Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceCreateSecretBody":{"type":"object","properties":{"name":{"type":"string","description":"Derived from `secret.display_name` when empty."},"secret":{"$ref":"#/components/schemas/v1Secret"},"backend_id":{"type":"string","description":"Backend that will store this secret. Must exist and serve the requesting\nscope. If omitted, the server picks the scope's single backend; if the\nscope has multiple applicable backends, the request is rejected with\nINVALID_ARGUMENT listing the candidates."}}}}},"paths":{"/api/v1/organizations/{organization_id}/secrets":{"post":{"summary":"Create Secret","description":"Create Secret.","operationId":"CreateSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Empty organization_id creates in the shared tier.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceCreateSecretBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Get Secret

> Get Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/secrets/{secret_id}":{"get":{"summary":"Get Secret","description":"Get Secret.","operationId":"GetSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Delete Secret

> Delete Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/secrets/{secret_id}":{"delete":{"summary":"Delete Secret","description":"Delete Secret.","operationId":"DeleteSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"purge_backend","description":"When true, delete the underlying backend storage for every version,\nincluding any versions that were adopted (not created by Gringotts).\nDefault (false) only removes the Gringotts wrapper — adopted backend\ndata stays put.","in":"query","required":false,"schema":{"type":"boolean"}}],"tags":["Secrets"]}}}}
```

## Update Secret

> Update Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceUpdateSecretBody":{"type":"object","properties":{"secret":{"$ref":"#/components/schemas/v1Secret"},"etag":{"type":"string"}}}}},"paths":{"/api/v1/organizations/{organization_id}/secrets/{secret_id}":{"patch":{"summary":"Update Secret","description":"Update Secret.","operationId":"UpdateSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceUpdateSecretBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Add Secret Version

> Add Secret Version.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1AddSecretVersionResponse":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/v1SecretVersion"},"authorize_url":{"type":"string","description":"OAuth acquisition path: the URL to send the user to for consent.\nPoll GetSecret until the secret leaves `pending_authorization`."}}},"v1SecretVersion":{"type":"object","properties":{"secret_id":{"type":"string"},"state":{"$ref":"#/components/schemas/SecretVersionState"},"create_time":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"}}},"SecretVersionState":{"type":"string","enum":["STATE_UNSPECIFIED","ENABLED","DISABLED","DESTROYED"],"default":"STATE_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceAddSecretVersionBody":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/v1SecretPayload"},"oauth_payload":{"$ref":"#/components/schemas/v1OAuthPayload"}}},"v1SecretPayload":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1SecretPayloadField"}}},"description":"Typed secret payload — one entry per field declared in the secret's\n`SecretType.schema`. Carried over the wire by `AddSecretVersion` and\n`AccessSecretVersion`; gringotts serializes to JSON before persisting."},"v1SecretPayloadField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/commonv1Value"}}},"commonv1Value":{"type":"object","properties":{"null_value":{"type":"string","title":"Represents the absence of a value (None/null/undefined)"},"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"list":{"$ref":"#/components/schemas/v1List"},"dictionary":{"$ref":"#/components/schemas/v1Dictionary"},"file":{"$ref":"#/components/schemas/v1FileValue"},"table":{"$ref":"#/components/schemas/v1TableValue"},"set":{"$ref":"#/components/schemas/v1Set"},"text_value":{"$ref":"#/components/schemas/v1TextValue"},"list_value":{"$ref":"#/components/schemas/commonv1ListValue"},"set_value":{"$ref":"#/components/schemas/v1SetValue"},"dictionary_value":{"$ref":"#/components/schemas/v1DictionaryValue"}},"description":"Represents a runtime value that can be produced by the Jarvis interpreter.\n\nThis message provides a type-safe way to serialize and transmit values between\nthe Jarvis interpreter and other services via gRPC. It supports all the basic\ndata types that can be represented in the Jarvis language runtime.\n\nThe oneof structure ensures that exactly one value type is set at a time,\nproviding both type safety and efficient serialization."},"v1Number":{"type":"object","properties":{"lo":{"type":"integer","format":"int64","description":"Low 32 bits of the 96-bit mantissa."},"mid":{"type":"integer","format":"int64","description":"Middle 32 bits of the 96-bit mantissa."},"hi":{"type":"integer","format":"int64","description":"High 32 bits of the 96-bit mantissa."},"flags":{"type":"integer","format":"int64","description":"Flags word:\n - Bits 16–23: scale (0–28)\n - Bit 31: sign (0 = positive, 1 = negative)\n - Other bits must be zero."}},"description":"A fixed-precision decimal number with up to 28 fractional digits.\n\nThis message represents decimal numbers with exact precision, avoiding\nfloating-point rounding errors. It's particularly useful for financial\ncalculations, measurements, and any scenario where exact decimal\nrepresentation is required.\n\nThe value is calculated as: m / 10^e, where:\n - m is an unsigned 96-bit integer composed of (lo, mid, hi)\n - e is the scale (0–28) stored in flags bits 16–23\n - sign is encoded in flags bit 31 (0 = positive, 1 = negative)\n\nExamples:\n - 123.45 would have m=12345, e=2\n - -0.001 would have m=1, e=3, with sign bit set\n"},"typeDate":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year."},"month":{"type":"integer","format":"int32","description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day."},"day":{"type":"integer","format":"int32","description":"Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant."}},"description":"* A full date, with non-zero year, month, and day values\n* A month and day value, with a zero year, such as an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, such as a credit card expiration\ndate\n\nRelated types are [google.type.TimeOfDay][google.type.TimeOfDay] and\n`google.protobuf.Timestamp`.","title":"Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:"},"typeTimeOfDay":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","description":"Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time."},"minutes":{"type":"integer","format":"int32","description":"Minutes of hour of day. Must be from 0 to 59."},"seconds":{"type":"integer","format":"int32","description":"Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds."},"nanos":{"type":"integer","format":"int32","description":"Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."}},"description":"Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are [google.type.Date][google.type.Date] and\n`google.protobuf.Timestamp`."},"typeDateTime":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year."},"month":{"type":"integer","format":"int32","description":"Required. Month of year. Must be from 1 to 12."},"day":{"type":"integer","format":"int32","description":"Required. Day of month. Must be from 1 to 31 and valid for the year and\nmonth."},"hours":{"type":"integer","format":"int32","description":"Required. Hours of day in 24 hour format. Should be from 0 to 23. An API\nmay choose to allow the value \"24:00:00\" for scenarios like business\nclosing time."},"minutes":{"type":"integer","format":"int32","description":"Required. Minutes of hour of day. Must be from 0 to 59."},"seconds":{"type":"integer","format":"int32","description":"Required. Seconds of minutes of the time. Must normally be from 0 to 59. An\nAPI may allow the value 60 if it allows leap-seconds."},"nanos":{"type":"integer","format":"int32","description":"Required. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999."},"utc_offset":{"type":"string","description":"UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }."},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"}},"description":"Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n   day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n   day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n   day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year is 0, the DateTime is considered not to have a specific year. month\nand day must have valid, non-zero values.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations."},"typeTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"IANA Time Zone Database time zone, e.g. \"America/New_York\"."},"version":{"type":"string","description":"Optional. IANA Time Zone Database version number, e.g. \"2019a\"."}},"description":"Represents a time zone from the\n[IANA Time Zone Database](https://www.iana.org/time-zones)."},"v1List":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/commonV1Value"},"title":"The ordered sequence of values in this list"}},"description":"Represents an ordered collection of values (similar to arrays or lists).\n\nThis message can contain any number of Value elements in a specific order.\nLists are mutable and can grow or shrink during runtime. Elements can be\naccessed by their zero-based index position.\n\nExamples:\n - [1, 2, 3] - list of numbers\n - [\"hello\", \"world\"] - list of strings\n - [true, 42, \"mixed\"] - list with mixed types\n - [[1, 2], [3, 4]] - nested lists"},"commonV1Value":{"type":"object","properties":{"null_value":{"type":"string","title":"Represents the absence of a value (None/null/undefined)"},"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"list":{"$ref":"#/components/schemas/v1List"},"dictionary":{"$ref":"#/components/schemas/v1Dictionary"},"file":{"$ref":"#/components/schemas/v1FileValue"},"table":{"$ref":"#/components/schemas/v1TableValue"},"set":{"$ref":"#/components/schemas/v1Set"},"text_value":{"$ref":"#/components/schemas/v1TextValue"},"list_value":{"$ref":"#/components/schemas/commonv1ListValue"},"set_value":{"$ref":"#/components/schemas/v1SetValue"},"dictionary_value":{"$ref":"#/components/schemas/v1DictionaryValue"}},"description":"Represents a runtime value that can be produced by the Jarvis interpreter.\n\nThis message provides a type-safe way to serialize and transmit values between\nthe Jarvis interpreter and other services via gRPC. It supports all the basic\ndata types that can be represented in the Jarvis language runtime.\n\nThe oneof structure ensures that exactly one value type is set at a time,\nproviding both type safety and efficient serialization."},"v1Dictionary":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/v1DictionaryEntry"},"title":"The key-value pairs stored in this dictionary"}},"description":"Represents a key-value mapping (similar to hash maps or dictionaries).\n\nThis message stores associations between keys and values, where keys must be\nhashable types (null, bool, Number, string, Date, TimeOfDay, DateTime, TimeZone). Keys are\nunique within a dictionary - duplicate keys will overwrite previous values.\n\nThe dictionary maintains insertion order for consistent iteration behavior.\n\nExamples:\n - {\"name\": \"John\", \"age\": 30} - string keys with mixed values\n - {1: \"one\", 2: \"two\"} - number keys with string values\n - {\"nested\": {\"inner\": \"value\"}} - nested dictionaries"},"v1DictionaryEntry":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/v1HashableValue"},"value":{"$ref":"#/components/schemas/commonV1Value"}},"description":"Represents a single key-value pair within a Dictionary.\n\nBoth key and value can be any Value type, though keys should be\nhashable types for proper dictionary behavior. Non-hashable keys\n(like lists or dictionaries) may cause runtime errors."},"v1HashableValue":{"type":"object","properties":{"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"text_value":{"$ref":"#/components/schemas/v1TextValue"}},"description":"Represents a hashable value that can be used as a dictionary key.\n\nThis message contains only the hashable types from the Value message,\ncorresponding to Python's hashable types. These types can be safely\nused as keys in maps and dictionaries.\n\nHashable types include: bool, Number, string, Date, TimeOfDay, DateTime\nand Duration."},"v1TextValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote text content via URL or file path"},"inline":{"type":"string","title":"Text content embedded directly in the message"}},"description":"Represents a text value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling text strings in the Jarvis interpreter:\n- Small strings can be embedded directly using the inline option\n- Large strings can be referenced by URL using the remote option\n- The choice depends on string size, network constraints, and access patterns"},"v1FileValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to a remote file via URL or file path"},"inline":{"$ref":"#/components/schemas/v1File"}},"description":"Represents a file value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling files in the Jarvis interpreter:\n- Small files can be embedded directly using the inline option\n- Large files can be referenced by URL/path using the remote option\n- The choice depends on file size, network constraints, and access patterns"},"v1File":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"The raw binary content of the file"},"name":{"type":"string","title":"The name of the file, including extension if applicable"}},"description":"Represents a file with its name and binary content.\n\nThis message contains the complete file data including both metadata\n(filename) and the actual file content as raw bytes. It's used for\nembedding files directly within messages when the file size is\nmanageable and immediate access is required.\n\nExamples:\n - Configuration files\n - Small text or binary files\n - Generated reports or documents\n - Temporary files created during execution\n"},"v1TableValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to a remote table via URL or file path (feather-v2 format)"},"inline":{"$ref":"#/components/schemas/v1Table"}},"description":"Represents a table value that can be either stored inline or referenced remotely."},"v1Table":{"type":"object","properties":{"data":{"type":"string","format":"byte","title":"The table data serialized in feather-v2 format"}},"description":"Represents a table with data in feather-v2 format.\n\nThis message contains the complete table data serialized using the\nfeather-v2 format, which provides efficient columnar storage and\nfast serialization/deserialization for tabular data."},"v1Set":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/v1HashableValue"},"title":"The unique elements stored in this set\nAll elements must be hashable types"}},"description":"Represents an unordered collection of unique values.\n\nThis message stores a collection of unique elements, where duplicate values\nare automatically removed. Only hashable types can be stored in sets.\nSets are useful for membership testing, removing duplicates, and mathematical\nset operations like union, intersection, and difference.\n\nThe set does not maintain insertion order - elements may appear in any order\nduring iteration.\n\nExamples:\n - {1, 2, 3} - set of numbers\n - {\"apple\", \"banana\", \"cherry\"} - set of strings\n - {true, false} - set of booleans\n - {1, \"hello\", true} - set with mixed hashable types"},"commonv1ListValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote list data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1List"}},"description":"Represents a list value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large lists:\n- Small lists can be embedded directly using the inline option\n- Large lists can be referenced by URL using the remote option"},"v1SetValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote set data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1Set"}},"description":"Represents a set value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large sets:\n- Small sets can be embedded directly using the inline option\n- Large sets can be referenced by URL using the remote option"},"v1DictionaryValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote dictionary data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1Dictionary"}},"description":"Represents a dictionary value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large dictionaries:\n- Small dictionaries can be embedded directly using the inline option\n- Large dictionaries can be referenced by URL using the remote option"},"v1OAuthPayload":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"Requested scopes. Empty = use the OAuth app's configured `scopes`;\nnon-empty *overrides* them (it does not augment)."},"arguments":{"type":"object","additionalProperties":{"type":"string"},"description":"Values for the OAuth app's declared template `arguments` (e.g.\n`tenant`), substituted into the `{arg}` placeholders in the endpoints."}},"description":"Inputs that begin an OAuth authorization-code flow for an OAuth-kind\nsecret. Not token data — it carries what's needed to build the authorize\nURL; the tokens land later, on the callback."}}},"paths":{"/api/v1/organizations/{organization_id}/secrets/{secret_id}:addVersion":{"post":{"summary":"Add Secret Version","description":"Add Secret Version.","operationId":"AddSecretVersion","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1AddSecretVersionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceAddSecretVersionBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Adopt Secret

> Wrap an existing backend entry as a GringottsSecret. No payload is\
> written; version 1 of the new secret references the existing storage.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceAdoptSecretBody":{"type":"object","properties":{"name":{"type":"string","description":"Derived from `secret.display_name` when empty."},"reference":{"type":"object","additionalProperties":{"type":"string"},"description":"Opaque reference returned from DiscoverInventory."},"secret":{"$ref":"#/components/schemas/v1Secret"},"backend_id":{"type":"string","description":"Backend the reference lives in. Required: a reference is meaningless\nwithout the backend it was discovered from. Pair with the same backend\nyou passed to `DiscoverInventory`."}}}}},"paths":{"/api/v1/organizations/{organization_id}/secrets:adopt":{"post":{"summary":"Adopt Secret","description":"Wrap an existing backend entry as a GringottsSecret. No payload is\nwritten; version 1 of the new secret references the existing storage.","operationId":"AdoptSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceAdoptSecretBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## List Backends

> List Backends.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListBackendsResponse":{"type":"object","properties":{"backends":{"type":"array","items":{"$ref":"#/components/schemas/v1Backend"}},"next_page_token":{"type":"string"}}},"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/backends":{"get":{"summary":"List Backends","description":"List Backends.","operationId":"ListWorkspaceBackends","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListBackendsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Create Backend

> Create Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/backends":{"post":{"summary":"Create Backend","description":"Create Backend.","operationId":"CreateWorkspaceBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}},"description":"The backend body. `backend.display_name` is required. `backend.name`,\n`backend.create_time`, `backend.etag`, `backend.status`, and\n`backend.kognitos_managed` are set by the server and ignored on\ninput. The id (trailing segment of `backend.name`) is generated by\nthe server as `<type-prefix>-<random-suffix>` (e.g. `aws-7az92kdr`).","required":true},"tags":["Secrets"]}}}}
```

## Get Backend

> Get Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/backends/{backend_id}":{"get":{"summary":"Get Backend","description":"Get Backend.","operationId":"GetWorkspaceBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Delete Backend

> Delete Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/backends/{backend_id}":{"delete":{"summary":"Delete Backend","description":"Delete Backend.","operationId":"DeleteWorkspaceBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Update Backend

> Update Backend.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Backend":{"type":"object","properties":{"name":{"type":"string","description":"The `{id}` segment is server-generated (e.g. `aws-7az92kdr`); see\n[CreateBackendRequest]. The full resource name is what callers pass\nback to `GetBackend` / `DeleteBackend`. The trailing id segment is\nwhat callers use as `backend` on `CreateSecret`, `AdoptSecret`, and\n`DiscoverInventory`.","title":"Resource name. One of:\n  backends/{id}                                          (platform default)\n  organizations/{org}/backends/{id}                      (org-scoped)\n  organizations/{org}/workspaces/{ws}/backends/{id}      (workspace-scoped)"},"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}},"v1AuthConfig":{"type":"object","properties":{"method":{"type":"string","description":"Auth method id matching an AuthMethodSpec.id in the type's catalog\nentry. e.g. \"default\", \"static_keys\", \"assume_role\"."},"fields":{"type":"object","description":"Method-specific field values. SECRET_REFERENCE-typed fields submitted\nhere are written by the server to a core/v1.Secret in the `gringotts`\nnamespace; the CRD stores only the reference. On read-back they are\nsuppressed entirely."}}},"v1BackendStatus":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/v1BackendHealth"},"last_checked":{"type":"string","format":"date-time"},"message":{"type":"string"}}},"v1BackendHealth":{"type":"string","enum":["BACKEND_HEALTH_UNSPECIFIED","BACKEND_HEALTH_HEALTHY","BACKEND_HEALTH_DEGRADED","BACKEND_HEALTH_UNHEALTHY","BACKEND_HEALTH_UNKNOWN"],"default":"BACKEND_HEALTH_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/backends/{backend_id}":{"patch":{"summary":"Update Backend","description":"Update Backend.","operationId":"UpdateWorkspaceBackend","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Backend"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type_id":{"type":"string","description":"Stable identifier matching a BackendTypeInfo.type_id returned by\nListBackendTypes. e.g. \"aws-secrets-manager\" for BYO, \"kognitos-managed\"\nfor the platform default (opaque — implementation hidden from callers)."},"config":{"type":"object","description":"Backend-specific configuration. Schema lives in the catalog\n(`BackendTypeInfo.config_fields`); server validates at write time."},"auth":{"$ref":"#/components/schemas/v1AuthConfig"},"status":{"$ref":"#/components/schemas/v1BackendStatus"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string"},"kognitos_managed":{"type":"boolean","description":"True when this backend is the Kognitos-managed platform default —\nits implementation, config, and credentials are entirely opaque to\nthe customer and only Kognitos can change it. False for customer-\nowned backends (BYO), which the customer creates, configures, and\ncan update or delete."},"display_name":{"type":"string","description":"Human-readable label, customer-chosen at create time. Mutable via\nUpdateBackend without changing the resource name. Required on\n`CreateBackend` (server rejects empty); on read-back, falls back to\nthe trailing-segment id for backends predating this field."}}}}},"required":true},"tags":["Secrets"]}}}}
```

## List O Auth Apps

> List O Auth Apps.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListOAuthAppsResponse":{"type":"object","properties":{"oauth_apps":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthApp"}},"next_page_token":{"type":"string"}}},"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/oauthApps":{"get":{"summary":"List O Auth Apps","description":"List O Auth Apps.","operationId":"ListWorkspaceOAuthApps","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListOAuthAppsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Create O Auth App

> Create O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"OAuthAppServiceCreateOAuthAppBody":{"type":"object","properties":{"name":{"type":"string","description":"Derived from `oauth_app.display_name` when empty."},"oauth_app":{"$ref":"#/components/schemas/v1OAuthApp"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/oauthApps":{"post":{"summary":"Create O Auth App","description":"Create O Auth App.","operationId":"CreateWorkspaceOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Empty organization_id creates in the shared tier.","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthAppServiceCreateOAuthAppBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Get O Auth App

> Get O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/oauthApps/{oauth_app_id}":{"get":{"summary":"Get O Auth App","description":"Get O Auth App.","operationId":"GetWorkspaceOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"oauth_app_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Delete O Auth App

> Delete O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/oauthApps/{oauth_app_id}":{"delete":{"summary":"Delete O Auth App","description":"Delete O Auth App.","operationId":"DeleteWorkspaceOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"oauth_app_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"purge_credentials","description":"When true, also delete the stored client credentials from the managed\ncredential store. Default leaves them (mirrors `--purge-credentials`\non backends); purge errors are logged, not fatal.","in":"query","required":false,"schema":{"type":"boolean"}}],"tags":["Secrets"]}}}}
```

## Update O Auth App

> Update O Auth App.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; what `Secret.oauth_app_id` binds to."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe app's path segment in the credential store."},"display_name":{"type":"string","description":"Required on create (server rejects empty)."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form, extensible key/value metadata — e.g. a description, a link\nto the app's provider-console page, an owner. Not interpreted by the\nserver; stored as-is and returned on read. Add new keys without a\nschema change."},"config":{"$ref":"#/components/schemas/v1OAuthConfig"},"credentials":{"$ref":"#/components/schemas/v1OAuthAppCredentials"},"create_time":{"type":"string","format":"date-time"},"etag":{"type":"string","description":"Optimistic-concurrency token; send it back on `UpdateOAuthApp`."},"secret_type":{"type":"string","description":"Name of the `SecretType` this app's connections use. Required on create;\nan app without one (created before this field) can have it set once via\n`UpdateOAuthApp`, after which it is immutable."}}},"v1OAuthConfig":{"type":"object","properties":{"authorize_url":{"type":"string","description":"Provider authorization endpoint. May contain `{arg}` placeholders that\nare filled per connection from the declared `arguments` (e.g.\n\".../{tenant}/oauth2/v2.0/authorize\")."},"token_url":{"type":"string","description":"Provider token endpoint. May contain `{arg}` placeholders, same as\n`authorize_url`."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes requested at authorization."},"extra_authorize_params":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra query params appended to the authorize URL — the home for\nprovider quirks that used to be hardcoded (e.g. Google\n`access_type=offline`, `prompt=consent`)."},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/v1OAuthArgument"},"description":"Per-connection template variables the endpoints reference via `{id}`.\nTheir values are supplied at connect time (AddSecretVersion.arguments)."},"grant_type":{"$ref":"#/components/schemas/v1OAuthGrantType"}},"description":"Declarative OAuth flow config (\"recipe\"). The integrations owner authors\nthis; the engine executes it without knowing which provider it is."},"v1OAuthArgument":{"type":"object","properties":{"id":{"type":"string","description":"Placeholder id, matching `{id}` in the endpoints."},"label":{"type":"string","description":"Human-readable label for the value the caller must provide."},"required":{"type":"boolean","description":"When true, a connection must supply this argument (or `constant` must be\nset, or a `capture` must resolve it) or begin is rejected."},"constant":{"type":"string","description":"Fixed value used when the caller supplies none at connect time (e.g.\nAzure's `common`). Empty ⇒ the value must come from connect input."},"capture":{"$ref":"#/components/schemas/v1ArgumentCapture"}},"description":"A per-connection template variable (e.g. `tenant`) referenced as `{id}`\nin the endpoints and supplied when a connection is created."},"v1ArgumentCapture":{"type":"object","properties":{"response_field":{"type":"string","description":"Dotted path into the token JSON response, e.g. `authed_user.id`."},"token_claim":{"$ref":"#/components/schemas/v1TokenClaim"}},"description":"Where a captured argument value is read from within a token response."},"v1TokenClaim":{"type":"object","properties":{"token_field":{"type":"string","description":"Which response field holds the JWT, e.g. `id_token` or `access_token`."},"claim":{"type":"string","description":"Claim name to read from the JWT payload, e.g. `tid`."}}},"v1OAuthGrantType":{"type":"string","enum":["OAUTH_GRANT_TYPE_UNSPECIFIED","OAUTH_GRANT_TYPE_AUTHORIZATION_CODE","OAUTH_GRANT_TYPE_CLIENT_CREDENTIALS"],"default":"OAUTH_GRANT_TYPE_UNSPECIFIED","description":"OAuth grant type. UNSPECIFIED is treated as AUTHORIZATION_CODE (back-compat\nwith apps registered before this field existed)."},"v1OAuthAppCredentials":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string","description":"Write-only. Stored in the managed credential store; never returned."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/oauthApps/{oauth_app_id}":{"patch":{"summary":"Update O Auth App","description":"Update O Auth App.","operationId":"UpdateWorkspaceOAuthApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"oauth_app_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"update_mask","description":"Updatable: `display_name`, `metadata`, `secret_type`. `secret_type` is\nset-once: resending the current value is a no-op, a different one is\nrejected. Empty ⇒ every populated updatable field (AIP-134), so clearing\n`metadata` requires naming it here.","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1OAuthApp"}}},"description":"`oauth_app.etag`, when set, must match the app's current etag (AIP-154).","required":true},"tags":["Secrets"]}}}}
```

## List Secrets

> List Secrets.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListSecretsResponse":{"type":"object","properties":{"secrets":{"type":"array","items":{"$ref":"#/components/schemas/v1Secret"}},"next_page_token":{"type":"string"}}},"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets":{"get":{"summary":"List Secrets","description":"List Secrets.","operationId":"ListWorkspaceSecrets","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListSecretsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Create Secret

> Create Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceCreateSecretBody":{"type":"object","properties":{"name":{"type":"string","description":"Derived from `secret.display_name` when empty."},"secret":{"$ref":"#/components/schemas/v1Secret"},"backend_id":{"type":"string","description":"Backend that will store this secret. Must exist and serve the requesting\nscope. If omitted, the server picks the scope's single backend; if the\nscope has multiple applicable backends, the request is rejected with\nINVALID_ARGUMENT listing the candidates."}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets":{"post":{"summary":"Create Secret","description":"Create Secret.","operationId":"CreateWorkspaceSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","description":"Empty organization_id creates in the shared tier.","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceCreateSecretBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Get Secret

> Get Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets/{secret_id}":{"get":{"summary":"Get Secret","description":"Get Secret.","operationId":"GetWorkspaceSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Delete Secret

> Delete Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets/{secret_id}":{"delete":{"summary":"Delete Secret","description":"Delete Secret.","operationId":"DeleteWorkspaceSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"purge_backend","description":"When true, delete the underlying backend storage for every version,\nincluding any versions that were adopted (not created by Gringotts).\nDefault (false) only removes the Gringotts wrapper — adopted backend\ndata stays put.","in":"query","required":false,"schema":{"type":"boolean"}}],"tags":["Secrets"]}}}}
```

## Update Secret

> Update Secret.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceUpdateSecretBody":{"type":"object","properties":{"secret":{"$ref":"#/components/schemas/v1Secret"},"etag":{"type":"string"}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets/{secret_id}":{"patch":{"summary":"Update Secret","description":"Update Secret.","operationId":"UpdateWorkspaceSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceUpdateSecretBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Add Secret Version

> Add Secret Version.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1AddSecretVersionResponse":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/v1SecretVersion"},"authorize_url":{"type":"string","description":"OAuth acquisition path: the URL to send the user to for consent.\nPoll GetSecret until the secret leaves `pending_authorization`."}}},"v1SecretVersion":{"type":"object","properties":{"secret_id":{"type":"string"},"state":{"$ref":"#/components/schemas/SecretVersionState"},"create_time":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"}}},"SecretVersionState":{"type":"string","enum":["STATE_UNSPECIFIED","ENABLED","DISABLED","DESTROYED"],"default":"STATE_UNSPECIFIED"},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceAddSecretVersionBody":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/v1SecretPayload"},"oauth_payload":{"$ref":"#/components/schemas/v1OAuthPayload"}}},"v1SecretPayload":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1SecretPayloadField"}}},"description":"Typed secret payload — one entry per field declared in the secret's\n`SecretType.schema`. Carried over the wire by `AddSecretVersion` and\n`AccessSecretVersion`; gringotts serializes to JSON before persisting."},"v1SecretPayloadField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/commonv1Value"}}},"commonv1Value":{"type":"object","properties":{"null_value":{"type":"string","title":"Represents the absence of a value (None/null/undefined)"},"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"list":{"$ref":"#/components/schemas/v1List"},"dictionary":{"$ref":"#/components/schemas/v1Dictionary"},"file":{"$ref":"#/components/schemas/v1FileValue"},"table":{"$ref":"#/components/schemas/v1TableValue"},"set":{"$ref":"#/components/schemas/v1Set"},"text_value":{"$ref":"#/components/schemas/v1TextValue"},"list_value":{"$ref":"#/components/schemas/commonv1ListValue"},"set_value":{"$ref":"#/components/schemas/v1SetValue"},"dictionary_value":{"$ref":"#/components/schemas/v1DictionaryValue"}},"description":"Represents a runtime value that can be produced by the Jarvis interpreter.\n\nThis message provides a type-safe way to serialize and transmit values between\nthe Jarvis interpreter and other services via gRPC. It supports all the basic\ndata types that can be represented in the Jarvis language runtime.\n\nThe oneof structure ensures that exactly one value type is set at a time,\nproviding both type safety and efficient serialization."},"v1Number":{"type":"object","properties":{"lo":{"type":"integer","format":"int64","description":"Low 32 bits of the 96-bit mantissa."},"mid":{"type":"integer","format":"int64","description":"Middle 32 bits of the 96-bit mantissa."},"hi":{"type":"integer","format":"int64","description":"High 32 bits of the 96-bit mantissa."},"flags":{"type":"integer","format":"int64","description":"Flags word:\n - Bits 16–23: scale (0–28)\n - Bit 31: sign (0 = positive, 1 = negative)\n - Other bits must be zero."}},"description":"A fixed-precision decimal number with up to 28 fractional digits.\n\nThis message represents decimal numbers with exact precision, avoiding\nfloating-point rounding errors. It's particularly useful for financial\ncalculations, measurements, and any scenario where exact decimal\nrepresentation is required.\n\nThe value is calculated as: m / 10^e, where:\n - m is an unsigned 96-bit integer composed of (lo, mid, hi)\n - e is the scale (0–28) stored in flags bits 16–23\n - sign is encoded in flags bit 31 (0 = positive, 1 = negative)\n\nExamples:\n - 123.45 would have m=12345, e=2\n - -0.001 would have m=1, e=3, with sign bit set\n"},"typeDate":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year."},"month":{"type":"integer","format":"int32","description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day."},"day":{"type":"integer","format":"int32","description":"Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant."}},"description":"* A full date, with non-zero year, month, and day values\n* A month and day value, with a zero year, such as an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, such as a credit card expiration\ndate\n\nRelated types are [google.type.TimeOfDay][google.type.TimeOfDay] and\n`google.protobuf.Timestamp`.","title":"Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:"},"typeTimeOfDay":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","description":"Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time."},"minutes":{"type":"integer","format":"int32","description":"Minutes of hour of day. Must be from 0 to 59."},"seconds":{"type":"integer","format":"int32","description":"Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds."},"nanos":{"type":"integer","format":"int32","description":"Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."}},"description":"Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are [google.type.Date][google.type.Date] and\n`google.protobuf.Timestamp`."},"typeDateTime":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year."},"month":{"type":"integer","format":"int32","description":"Required. Month of year. Must be from 1 to 12."},"day":{"type":"integer","format":"int32","description":"Required. Day of month. Must be from 1 to 31 and valid for the year and\nmonth."},"hours":{"type":"integer","format":"int32","description":"Required. Hours of day in 24 hour format. Should be from 0 to 23. An API\nmay choose to allow the value \"24:00:00\" for scenarios like business\nclosing time."},"minutes":{"type":"integer","format":"int32","description":"Required. Minutes of hour of day. Must be from 0 to 59."},"seconds":{"type":"integer","format":"int32","description":"Required. Seconds of minutes of the time. Must normally be from 0 to 59. An\nAPI may allow the value 60 if it allows leap-seconds."},"nanos":{"type":"integer","format":"int32","description":"Required. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999."},"utc_offset":{"type":"string","description":"UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }."},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"}},"description":"Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n   day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n   day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n   day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year is 0, the DateTime is considered not to have a specific year. month\nand day must have valid, non-zero values.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations."},"typeTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"IANA Time Zone Database time zone, e.g. \"America/New_York\"."},"version":{"type":"string","description":"Optional. IANA Time Zone Database version number, e.g. \"2019a\"."}},"description":"Represents a time zone from the\n[IANA Time Zone Database](https://www.iana.org/time-zones)."},"v1List":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/commonV1Value"},"title":"The ordered sequence of values in this list"}},"description":"Represents an ordered collection of values (similar to arrays or lists).\n\nThis message can contain any number of Value elements in a specific order.\nLists are mutable and can grow or shrink during runtime. Elements can be\naccessed by their zero-based index position.\n\nExamples:\n - [1, 2, 3] - list of numbers\n - [\"hello\", \"world\"] - list of strings\n - [true, 42, \"mixed\"] - list with mixed types\n - [[1, 2], [3, 4]] - nested lists"},"commonV1Value":{"type":"object","properties":{"null_value":{"type":"string","title":"Represents the absence of a value (None/null/undefined)"},"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"list":{"$ref":"#/components/schemas/v1List"},"dictionary":{"$ref":"#/components/schemas/v1Dictionary"},"file":{"$ref":"#/components/schemas/v1FileValue"},"table":{"$ref":"#/components/schemas/v1TableValue"},"set":{"$ref":"#/components/schemas/v1Set"},"text_value":{"$ref":"#/components/schemas/v1TextValue"},"list_value":{"$ref":"#/components/schemas/commonv1ListValue"},"set_value":{"$ref":"#/components/schemas/v1SetValue"},"dictionary_value":{"$ref":"#/components/schemas/v1DictionaryValue"}},"description":"Represents a runtime value that can be produced by the Jarvis interpreter.\n\nThis message provides a type-safe way to serialize and transmit values between\nthe Jarvis interpreter and other services via gRPC. It supports all the basic\ndata types that can be represented in the Jarvis language runtime.\n\nThe oneof structure ensures that exactly one value type is set at a time,\nproviding both type safety and efficient serialization."},"v1Dictionary":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/v1DictionaryEntry"},"title":"The key-value pairs stored in this dictionary"}},"description":"Represents a key-value mapping (similar to hash maps or dictionaries).\n\nThis message stores associations between keys and values, where keys must be\nhashable types (null, bool, Number, string, Date, TimeOfDay, DateTime, TimeZone). Keys are\nunique within a dictionary - duplicate keys will overwrite previous values.\n\nThe dictionary maintains insertion order for consistent iteration behavior.\n\nExamples:\n - {\"name\": \"John\", \"age\": 30} - string keys with mixed values\n - {1: \"one\", 2: \"two\"} - number keys with string values\n - {\"nested\": {\"inner\": \"value\"}} - nested dictionaries"},"v1DictionaryEntry":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/v1HashableValue"},"value":{"$ref":"#/components/schemas/commonV1Value"}},"description":"Represents a single key-value pair within a Dictionary.\n\nBoth key and value can be any Value type, though keys should be\nhashable types for proper dictionary behavior. Non-hashable keys\n(like lists or dictionaries) may cause runtime errors."},"v1HashableValue":{"type":"object","properties":{"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"text_value":{"$ref":"#/components/schemas/v1TextValue"}},"description":"Represents a hashable value that can be used as a dictionary key.\n\nThis message contains only the hashable types from the Value message,\ncorresponding to Python's hashable types. These types can be safely\nused as keys in maps and dictionaries.\n\nHashable types include: bool, Number, string, Date, TimeOfDay, DateTime\nand Duration."},"v1TextValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote text content via URL or file path"},"inline":{"type":"string","title":"Text content embedded directly in the message"}},"description":"Represents a text value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling text strings in the Jarvis interpreter:\n- Small strings can be embedded directly using the inline option\n- Large strings can be referenced by URL using the remote option\n- The choice depends on string size, network constraints, and access patterns"},"v1FileValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to a remote file via URL or file path"},"inline":{"$ref":"#/components/schemas/v1File"}},"description":"Represents a file value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling files in the Jarvis interpreter:\n- Small files can be embedded directly using the inline option\n- Large files can be referenced by URL/path using the remote option\n- The choice depends on file size, network constraints, and access patterns"},"v1File":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"The raw binary content of the file"},"name":{"type":"string","title":"The name of the file, including extension if applicable"}},"description":"Represents a file with its name and binary content.\n\nThis message contains the complete file data including both metadata\n(filename) and the actual file content as raw bytes. It's used for\nembedding files directly within messages when the file size is\nmanageable and immediate access is required.\n\nExamples:\n - Configuration files\n - Small text or binary files\n - Generated reports or documents\n - Temporary files created during execution\n"},"v1TableValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to a remote table via URL or file path (feather-v2 format)"},"inline":{"$ref":"#/components/schemas/v1Table"}},"description":"Represents a table value that can be either stored inline or referenced remotely."},"v1Table":{"type":"object","properties":{"data":{"type":"string","format":"byte","title":"The table data serialized in feather-v2 format"}},"description":"Represents a table with data in feather-v2 format.\n\nThis message contains the complete table data serialized using the\nfeather-v2 format, which provides efficient columnar storage and\nfast serialization/deserialization for tabular data."},"v1Set":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/v1HashableValue"},"title":"The unique elements stored in this set\nAll elements must be hashable types"}},"description":"Represents an unordered collection of unique values.\n\nThis message stores a collection of unique elements, where duplicate values\nare automatically removed. Only hashable types can be stored in sets.\nSets are useful for membership testing, removing duplicates, and mathematical\nset operations like union, intersection, and difference.\n\nThe set does not maintain insertion order - elements may appear in any order\nduring iteration.\n\nExamples:\n - {1, 2, 3} - set of numbers\n - {\"apple\", \"banana\", \"cherry\"} - set of strings\n - {true, false} - set of booleans\n - {1, \"hello\", true} - set with mixed hashable types"},"commonv1ListValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote list data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1List"}},"description":"Represents a list value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large lists:\n- Small lists can be embedded directly using the inline option\n- Large lists can be referenced by URL using the remote option"},"v1SetValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote set data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1Set"}},"description":"Represents a set value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large sets:\n- Small sets can be embedded directly using the inline option\n- Large sets can be referenced by URL using the remote option"},"v1DictionaryValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote dictionary data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1Dictionary"}},"description":"Represents a dictionary value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large dictionaries:\n- Small dictionaries can be embedded directly using the inline option\n- Large dictionaries can be referenced by URL using the remote option"},"v1OAuthPayload":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"Requested scopes. Empty = use the OAuth app's configured `scopes`;\nnon-empty *overrides* them (it does not augment)."},"arguments":{"type":"object","additionalProperties":{"type":"string"},"description":"Values for the OAuth app's declared template `arguments` (e.g.\n`tenant`), substituted into the `{arg}` placeholders in the endpoints."}},"description":"Inputs that begin an OAuth authorization-code flow for an OAuth-kind\nsecret. Not token data — it carries what's needed to build the authorize\nURL; the tokens land later, on the callback."}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets/{secret_id}:addVersion":{"post":{"summary":"Add Secret Version","description":"Add Secret Version.","operationId":"AddWorkspaceSecretVersion","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1AddSecretVersionResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceAddSecretVersionBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Adopt Secret

> Wrap an existing backend entry as a GringottsSecret. No payload is\
> written; version 1 of the new secret references the existing storage.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Secret":{"type":"object","properties":{"id":{"type":"string","description":"Server-generated nanoid; the only key RPCs address a secret by."},"name":{"type":"string","description":"Slug unique within `scope`, frozen at create — there is no rename. It is\nthe secret's path segment in the backing store."},"display_name":{"type":"string","description":"Required on create and adopt. Mutable."},"scope":{"type":"string","description":"`shared`, or `organizations/{org}[/workspaces/{ws}]`."},"secret_type":{"type":"string","description":"Name of the `SecretType` declaring this secret's payload schema (e.g.\n`postgres-creds`). Required on create, immutable thereafter."},"oauth_app_id":{"type":"string","description":"`OAuthApp.id` this connection authorizes against — the app to bind to on\n`CreateSecret`; echoed back on read. Empty for non-OAuth secrets."},"state":{"$ref":"#/components/schemas/v1SecretState"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"expires_at":{"type":"string","format":"date-time","description":"OAuth connections: when the access token expires, kept current by every\nrefresh. Unset when the token can't be renewed."},"current_version":{"type":"integer","format":"int64"},"etag":{"type":"string"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"}},"description":"A managed secret's metadata. Payload bytes are accessed separately via\n`AccessSecretVersion`; this message is metadata-only."},"v1SecretState":{"type":"string","enum":["SECRET_STATE_UNSPECIFIED","SECRET_STATE_ACTIVE","SECRET_STATE_PENDING_AUTHORIZATION","SECRET_STATE_DEGRADED"],"default":"SECRET_STATE_UNSPECIFIED","description":"Lifecycle state of a Secret.\n\n - SECRET_STATE_ACTIVE: Usable — a current version is available.\n - SECRET_STATE_PENDING_AUTHORIZATION: OAuth consent not yet completed (no version written).\n - SECRET_STATE_DEGRADED: Backing store compromised (see `state_reason` for the precise cause)."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"SecretServiceAdoptSecretBody":{"type":"object","properties":{"name":{"type":"string","description":"Derived from `secret.display_name` when empty."},"reference":{"type":"object","additionalProperties":{"type":"string"},"description":"Opaque reference returned from DiscoverInventory."},"secret":{"$ref":"#/components/schemas/v1Secret"},"backend_id":{"type":"string","description":"Backend the reference lives in. Required: a reference is meaningless\nwithout the backend it was discovered from. Pair with the same backend\nyou passed to `DiscoverInventory`."}}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/secrets:adopt":{"post":{"summary":"Adopt Secret","description":"Wrap an existing backend entry as a GringottsSecret. No payload is\nwritten; version 1 of the new secret references the existing storage.","operationId":"AdoptWorkspaceSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Secret"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretServiceAdoptSecretBody"}}},"required":true},"tags":["Secrets"]}}}}
```

## Discover Inventory

> Enumerate raw entries in the backend that serves a given scope,\
> whether or not Gringotts created them. Used by clients to power a\
> "pick existing entry" UI on the create-secret flow.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1DiscoverInventoryResponse":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/v1InventoryEntry"}},"next_page_token":{"type":"string"}}},"v1InventoryEntry":{"type":"object","properties":{"reference":{"type":"object","additionalProperties":{"type":"string"},"description":"Backend-specific reference. Opaque — pass straight back to AdoptSecret."},"display_name":{"type":"string","description":"Human-readable identifier (typically the last path segment)."},"already_managed":{"type":"boolean","description":"True if a GringottsSecret already wraps this entry."},"version_count":{"type":"integer","format":"int64","description":"Version count if the backend tracks it. Absent for backends that don't."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}:discoverInventory":{"get":{"summary":"Discover Inventory","description":"Enumerate raw entries in the backend that serves a given scope,\nwhether or not Gringotts created them. Used by clients to power a\n\"pick existing entry\" UI on the create-secret flow.","operationId":"DiscoverInventory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1DiscoverInventoryResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"backend_id","description":"Backend to inspect. Required when the scope has multiple applicable\nbackends; optional when there's exactly one (server picks).","in":"query","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Discover Inventory

> Enumerate raw entries in the backend that serves a given scope,\
> whether or not Gringotts created them. Used by clients to power a\
> "pick existing entry" UI on the create-secret flow.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1DiscoverInventoryResponse":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/v1InventoryEntry"}},"next_page_token":{"type":"string"}}},"v1InventoryEntry":{"type":"object","properties":{"reference":{"type":"object","additionalProperties":{"type":"string"},"description":"Backend-specific reference. Opaque — pass straight back to AdoptSecret."},"display_name":{"type":"string","description":"Human-readable identifier (typically the last path segment)."},"already_managed":{"type":"boolean","description":"True if a GringottsSecret already wraps this entry."},"version_count":{"type":"integer","format":"int64","description":"Version count if the backend tracks it. Absent for backends that don't."}}},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}:discoverInventory":{"get":{"summary":"Discover Inventory","description":"Enumerate raw entries in the backend that serves a given scope,\nwhether or not Gringotts created them. Used by clients to power a\n\"pick existing entry\" UI on the create-secret flow.","operationId":"DiscoverOrganizationInventory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1DiscoverInventoryResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"backend_id","description":"Backend to inspect. Required when the scope has multiple applicable\nbackends; optional when there's exactly one (server picks).","in":"query","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## List Secret Types

> List Secret Types.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListSecretTypesResponse":{"type":"object","properties":{"secret_types":{"type":"array","items":{"$ref":"#/components/schemas/v1SecretType"}},"next_page_token":{"type":"string"}}},"v1SecretType":{"type":"object","properties":{"name":{"type":"string","description":"Full resource name, `secretTypes/{name}`. Server-set on create."},"id":{"type":"string","description":"Server-generated stable id (NanoID). Used as the FK target on\n`secrets.secret_type_id`; never sent on create."},"display_name":{"type":"string"},"description":{"type":"string"},"schema":{"$ref":"#/components/schemas/v1SecretSchema"},"kind":{"$ref":"#/components/schemas/v1SecretTypeKind"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Filterable string key/value labels (matched as `labels.<key>`); mutable."}},"description":"Reusable typed schema for secrets of a given kind. Schemas are stored\nin the catalog and referenced by name from `Secret.secret_type`."},"v1SecretSchema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueDictionaryTypeField"}}},"description":"List of typed fields. Wrap a field's `value` in `common.v1.ValueOptionalType`\nto mark it optional, in `common.v1.ValueSensitiveType` to mark it as\nredacted on read."},"v1ValueDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string","title":"The name/key of this field"},"value":{"$ref":"#/components/schemas/v1ValueType"},"description":{"type":"string","title":"Optional human-readable description of this field"}},"title":"Represents a single field within a dictionary value type"},"v1ValueType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v1ValueScalarType"},"optional_type":{"$ref":"#/components/schemas/v1ValueOptionalType"},"list_type":{"$ref":"#/components/schemas/v1ValueListType"},"dictionary_type":{"$ref":"#/components/schemas/v1ValueDictionaryType"},"table_type":{"$ref":"#/components/schemas/v1ValueTableType"},"opaque_type":{"$ref":"#/components/schemas/v1ValueOpaqueType"},"any_type":{"$ref":"#/components/schemas/v1ValueAnyType"},"union_type":{"$ref":"#/components/schemas/v1ValueUnionType"},"sensitive_type":{"$ref":"#/components/schemas/v1ValueSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v1ValueEnumType"},"generic_dictionary_type":{"$ref":"#/components/schemas/v1ValueGenericDictionaryType"},"none_type":{"$ref":"#/components/schemas/v1ValueNoneType"}},"title":"Represents a complete value type definition using a discriminated union"},"v1ValueScalarType":{"type":"string","enum":["VALUE_SCALAR_TYPE_UNSPECIFIED","VALUE_SCALAR_TYPE_TEXT","VALUE_SCALAR_TYPE_NUMBER","VALUE_SCALAR_TYPE_BOOLEAN","VALUE_SCALAR_TYPE_DATETIME","VALUE_SCALAR_TYPE_DATE","VALUE_SCALAR_TYPE_TIME","VALUE_SCALAR_TYPE_FILE","VALUE_SCALAR_TYPE_TIMEDELTA"],"default":"VALUE_SCALAR_TYPE_UNSPECIFIED","description":"- VALUE_SCALAR_TYPE_UNSPECIFIED: Unspecified value type\n - VALUE_SCALAR_TYPE_TEXT: A text value type\n - VALUE_SCALAR_TYPE_NUMBER: A number value type\n - VALUE_SCALAR_TYPE_BOOLEAN: A boolean value type\n - VALUE_SCALAR_TYPE_DATETIME: A datetime value type\n - VALUE_SCALAR_TYPE_DATE: A date value type\n - VALUE_SCALAR_TYPE_TIME: A time value type\n - VALUE_SCALAR_TYPE_FILE: A file value type\n - VALUE_SCALAR_TYPE_TIMEDELTA: A timedelta value type","title":"Supported Value Scalar Types"},"v1ValueOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a value type that can be optional (nullable)"},"v1ValueListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a list/array value type containing elements of a specific type"},"v1ValueDictionaryType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this dictionary represents"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueDictionaryTypeField"},"title":"The named fields contained in this dictionary"},"description":{"type":"string","title":"Optional human-readable description of this dictionary type"}},"title":"Represents a dictionary/object value type with named fields"},"v1ValueTableType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this table represents"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueTableTypeColumn"},"title":"The columns that make up this table"},"description":{"type":"string","title":"Optional human-readable description of this table type"}},"title":"Represents a table value type with structured columns"},"v1ValueTableTypeColumn":{"type":"object","properties":{"key":{"type":"string","title":"The name/key of this column"},"value":{"$ref":"#/components/schemas/v1ValueType"},"description":{"type":"string","title":"Optional human-readable description of this column"}},"title":"Represents a single column within a table value type"},"v1ValueOpaqueType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this opaque type represents"},"description":{"type":"string","title":"Optional human-readable description of this opaque type"}},"title":"Represents an opaque value type with semantic meaning but unknown internal structure"},"v1ValueAnyType":{"type":"object","title":"Represents a value type that can hold any kind of value"},"v1ValueUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueType"},"title":"The possible value types in this union"}},"title":"Represents a union value type that can be one of several possible types"},"v1ValueSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a value type that contains sensitive information"},"v1ValueEnumType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this enum represents"},"members":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueEnumTypeMember"},"title":"The available options/members of this enum"},"description":{"type":"string","title":"Optional human-readable description of this enum type"}},"title":"Represents an enumeration value type with predefined options"},"v1ValueEnumTypeMember":{"type":"object","properties":{"name":{"type":"string","title":"The programmatic name of this enum member"},"description":{"type":"string","title":"Optional human-readable description of this enum member"}},"title":"Represents a single member/option within an enum value type"},"v1ValueGenericDictionaryType":{"type":"object","properties":{"key_type":{"$ref":"#/components/schemas/v1ValueType"},"value_type":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represent a generic dictionary that can hold any entry of a particular key and value type"},"v1ValueNoneType":{"type":"object","title":"Represents a none value type that can hold no value"},"v1SecretTypeKind":{"type":"object","properties":{"generic":{"$ref":"#/components/schemas/v1GenericKind"},"api_key":{"$ref":"#/components/schemas/v1ApiKeyKind"},"basic":{"$ref":"#/components/schemas/v1BasicKind"},"oauth":{"$ref":"#/components/schemas/v1OAuthKind"}},"description":"Discriminated union — new kinds are added as additive `oneof` arms when\nthey ship. OAuth is a single, provider-agnostic kind: all provider\nbehavior lives in the `OAuthApp` recipe (endpoints, scopes, params,\ntemplating), not in the kind."},"v1GenericKind":{"type":"object","description":"Schema-only; no acquisition behavior. The default for arbitrary\ncredential shapes."},"v1ApiKeyKind":{"type":"object","description":"Static API-key credentials, validated by the schema alone."},"v1BasicKind":{"type":"object","description":"Static username/password credentials, validated by the schema alone."},"v1OAuthKind":{"type":"object","description":"OAuth2 credentials (any provider). How the flow runs is fully described\nby the `OAuthApp`'s `OAuthConfig` recipe — gringotts has no\nprovider-specific code."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/secretTypes":{"get":{"summary":"List Secret Types","description":"List Secret Types.","operationId":"ListSecretTypes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListSecretTypesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"AIP-160 filter expression. See https://google.aip.dev/160.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Get Secret Type

> Get Secret Type.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1SecretType":{"type":"object","properties":{"name":{"type":"string","description":"Full resource name, `secretTypes/{name}`. Server-set on create."},"id":{"type":"string","description":"Server-generated stable id (NanoID). Used as the FK target on\n`secrets.secret_type_id`; never sent on create."},"display_name":{"type":"string"},"description":{"type":"string"},"schema":{"$ref":"#/components/schemas/v1SecretSchema"},"kind":{"$ref":"#/components/schemas/v1SecretTypeKind"},"create_time":{"type":"string","format":"date-time"},"update_time":{"type":"string","format":"date-time"},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Filterable string key/value labels (matched as `labels.<key>`); mutable."}},"description":"Reusable typed schema for secrets of a given kind. Schemas are stored\nin the catalog and referenced by name from `Secret.secret_type`."},"v1SecretSchema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueDictionaryTypeField"}}},"description":"List of typed fields. Wrap a field's `value` in `common.v1.ValueOptionalType`\nto mark it optional, in `common.v1.ValueSensitiveType` to mark it as\nredacted on read."},"v1ValueDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string","title":"The name/key of this field"},"value":{"$ref":"#/components/schemas/v1ValueType"},"description":{"type":"string","title":"Optional human-readable description of this field"}},"title":"Represents a single field within a dictionary value type"},"v1ValueType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v1ValueScalarType"},"optional_type":{"$ref":"#/components/schemas/v1ValueOptionalType"},"list_type":{"$ref":"#/components/schemas/v1ValueListType"},"dictionary_type":{"$ref":"#/components/schemas/v1ValueDictionaryType"},"table_type":{"$ref":"#/components/schemas/v1ValueTableType"},"opaque_type":{"$ref":"#/components/schemas/v1ValueOpaqueType"},"any_type":{"$ref":"#/components/schemas/v1ValueAnyType"},"union_type":{"$ref":"#/components/schemas/v1ValueUnionType"},"sensitive_type":{"$ref":"#/components/schemas/v1ValueSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v1ValueEnumType"},"generic_dictionary_type":{"$ref":"#/components/schemas/v1ValueGenericDictionaryType"},"none_type":{"$ref":"#/components/schemas/v1ValueNoneType"}},"title":"Represents a complete value type definition using a discriminated union"},"v1ValueScalarType":{"type":"string","enum":["VALUE_SCALAR_TYPE_UNSPECIFIED","VALUE_SCALAR_TYPE_TEXT","VALUE_SCALAR_TYPE_NUMBER","VALUE_SCALAR_TYPE_BOOLEAN","VALUE_SCALAR_TYPE_DATETIME","VALUE_SCALAR_TYPE_DATE","VALUE_SCALAR_TYPE_TIME","VALUE_SCALAR_TYPE_FILE","VALUE_SCALAR_TYPE_TIMEDELTA"],"default":"VALUE_SCALAR_TYPE_UNSPECIFIED","description":"- VALUE_SCALAR_TYPE_UNSPECIFIED: Unspecified value type\n - VALUE_SCALAR_TYPE_TEXT: A text value type\n - VALUE_SCALAR_TYPE_NUMBER: A number value type\n - VALUE_SCALAR_TYPE_BOOLEAN: A boolean value type\n - VALUE_SCALAR_TYPE_DATETIME: A datetime value type\n - VALUE_SCALAR_TYPE_DATE: A date value type\n - VALUE_SCALAR_TYPE_TIME: A time value type\n - VALUE_SCALAR_TYPE_FILE: A file value type\n - VALUE_SCALAR_TYPE_TIMEDELTA: A timedelta value type","title":"Supported Value Scalar Types"},"v1ValueOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a value type that can be optional (nullable)"},"v1ValueListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a list/array value type containing elements of a specific type"},"v1ValueDictionaryType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this dictionary represents"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueDictionaryTypeField"},"title":"The named fields contained in this dictionary"},"description":{"type":"string","title":"Optional human-readable description of this dictionary type"}},"title":"Represents a dictionary/object value type with named fields"},"v1ValueTableType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this table represents"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueTableTypeColumn"},"title":"The columns that make up this table"},"description":{"type":"string","title":"Optional human-readable description of this table type"}},"title":"Represents a table value type with structured columns"},"v1ValueTableTypeColumn":{"type":"object","properties":{"key":{"type":"string","title":"The name/key of this column"},"value":{"$ref":"#/components/schemas/v1ValueType"},"description":{"type":"string","title":"Optional human-readable description of this column"}},"title":"Represents a single column within a table value type"},"v1ValueOpaqueType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this opaque type represents"},"description":{"type":"string","title":"Optional human-readable description of this opaque type"}},"title":"Represents an opaque value type with semantic meaning but unknown internal structure"},"v1ValueAnyType":{"type":"object","title":"Represents a value type that can hold any kind of value"},"v1ValueUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueType"},"title":"The possible value types in this union"}},"title":"Represents a union value type that can be one of several possible types"},"v1ValueSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a value type that contains sensitive information"},"v1ValueEnumType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this enum represents"},"members":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueEnumTypeMember"},"title":"The available options/members of this enum"},"description":{"type":"string","title":"Optional human-readable description of this enum type"}},"title":"Represents an enumeration value type with predefined options"},"v1ValueEnumTypeMember":{"type":"object","properties":{"name":{"type":"string","title":"The programmatic name of this enum member"},"description":{"type":"string","title":"Optional human-readable description of this enum member"}},"title":"Represents a single member/option within an enum value type"},"v1ValueGenericDictionaryType":{"type":"object","properties":{"key_type":{"$ref":"#/components/schemas/v1ValueType"},"value_type":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represent a generic dictionary that can hold any entry of a particular key and value type"},"v1ValueNoneType":{"type":"object","title":"Represents a none value type that can hold no value"},"v1SecretTypeKind":{"type":"object","properties":{"generic":{"$ref":"#/components/schemas/v1GenericKind"},"api_key":{"$ref":"#/components/schemas/v1ApiKeyKind"},"basic":{"$ref":"#/components/schemas/v1BasicKind"},"oauth":{"$ref":"#/components/schemas/v1OAuthKind"}},"description":"Discriminated union — new kinds are added as additive `oneof` arms when\nthey ship. OAuth is a single, provider-agnostic kind: all provider\nbehavior lives in the `OAuthApp` recipe (endpoints, scopes, params,\ntemplating), not in the kind."},"v1GenericKind":{"type":"object","description":"Schema-only; no acquisition behavior. The default for arbitrary\ncredential shapes."},"v1ApiKeyKind":{"type":"object","description":"Static API-key credentials, validated by the schema alone."},"v1BasicKind":{"type":"object","description":"Static username/password credentials, validated by the schema alone."},"v1OAuthKind":{"type":"object","description":"OAuth2 credentials (any provider). How the flow runs is fully described\nby the `OAuthApp`'s `OAuthConfig` recipe — gringotts has no\nprovider-specific code."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/secretTypes/{secret_type_id}":{"get":{"summary":"Get Secret Type","description":"Get Secret Type.","operationId":"GetSecretType","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1SecretType"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"secret_type_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Secrets"]}}}}
```

## Validate Secret Schema

> Validate a typed payload against a schema. Pure check — no stored\
> secret is read, no payload is persisted. Returns \`valid = false\` plus\
> per-field violations on mismatch; never an \`INVALID\_ARGUMENT\` status.

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Secrets","description":"Manage secrets, secret backends, OAuth apps and secret types."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ValidateSecretSchemaResponse":{"type":"object","properties":{"valid":{"type":"boolean","description":"True iff `violations` is empty."},"violations":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestFieldViolation"},"description":"Per-field problems (missing required, type mismatch, unknown field).\nReasons are documented codes in the description, see\n`crate::secret_type::validator::ViolationReason`."}}},"BadRequestFieldViolation":{"type":"object","properties":{"field":{"type":"string","description":"A path that leads to a field in the request body. The value will be a\nsequence of dot-separated identifiers that identify a protocol buffer\nfield.\n\nConsider the following:\n\n    message CreateContactRequest {\n      message EmailAddress {\n        enum Type {\n          TYPE_UNSPECIFIED = 0;\n          HOME = 1;\n          WORK = 2;\n        }\n\n        optional string email = 1;\n        repeated EmailType type = 2;\n      }\n\n      string full_name = 1;\n      repeated EmailAddress email_addresses = 2;\n    }\n\nIn this example, in proto `field` could take one of the following values:\n\n* `full_name` for a violation in the `full_name` value\n* `email_addresses[0].email` for a violation in the `email` field of the\n  first `email_addresses` message\n* `email_addresses[2].type[1]` for a violation in the second `type`\n  value in the third `email_addresses` message.\n\nIn JSON, the same values are represented as:\n\n* `fullName` for a violation in the `fullName` value\n* `emailAddresses[0].email` for a violation in the `email` field of the\n  first `emailAddresses` message\n* `emailAddresses[2].type[1]` for a violation in the second `type`\n  value in the third `emailAddresses` message."},"description":{"type":"string","description":"A description of why the request element is bad."},"reason":{"type":"string","description":"The reason of the field-level error. This is a constant value that\nidentifies the proximate cause of the field-level error. It should\nuniquely identify the type of the FieldViolation within the scope of the\ngoogle.rpc.ErrorInfo.domain. This should be at most 63\ncharacters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,\nwhich represents UPPER_SNAKE_CASE."},"localized_message":{"$ref":"#/components/schemas/rpcLocalizedMessage"}},"description":"A message type used to describe a single bad request field."},"rpcLocalizedMessage":{"type":"object","properties":{"locale":{"type":"string","title":"The locale used following the specification defined at\nhttps://www.rfc-editor.org/rfc/bcp/bcp47.txt.\nExamples are: \"en-US\", \"fr-CH\", \"es-MX\""},"message":{"type":"string","description":"The localized error message in the above locale."}},"description":"Provides a localized error message that is safe to return to the user\nwhich can be attached to an RPC error."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"v1ValidateSecretSchemaRequest":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/v1SecretSchema"},"payload":{"$ref":"#/components/schemas/v1SecretPayload"}}},"v1SecretSchema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueDictionaryTypeField"}}},"description":"List of typed fields. Wrap a field's `value` in `common.v1.ValueOptionalType`\nto mark it optional, in `common.v1.ValueSensitiveType` to mark it as\nredacted on read."},"v1ValueDictionaryTypeField":{"type":"object","properties":{"key":{"type":"string","title":"The name/key of this field"},"value":{"$ref":"#/components/schemas/v1ValueType"},"description":{"type":"string","title":"Optional human-readable description of this field"}},"title":"Represents a single field within a dictionary value type"},"v1ValueType":{"type":"object","properties":{"scalar_type":{"$ref":"#/components/schemas/v1ValueScalarType"},"optional_type":{"$ref":"#/components/schemas/v1ValueOptionalType"},"list_type":{"$ref":"#/components/schemas/v1ValueListType"},"dictionary_type":{"$ref":"#/components/schemas/v1ValueDictionaryType"},"table_type":{"$ref":"#/components/schemas/v1ValueTableType"},"opaque_type":{"$ref":"#/components/schemas/v1ValueOpaqueType"},"any_type":{"$ref":"#/components/schemas/v1ValueAnyType"},"union_type":{"$ref":"#/components/schemas/v1ValueUnionType"},"sensitive_type":{"$ref":"#/components/schemas/v1ValueSensitiveType"},"enum_type":{"$ref":"#/components/schemas/v1ValueEnumType"},"generic_dictionary_type":{"$ref":"#/components/schemas/v1ValueGenericDictionaryType"},"none_type":{"$ref":"#/components/schemas/v1ValueNoneType"}},"title":"Represents a complete value type definition using a discriminated union"},"v1ValueScalarType":{"type":"string","enum":["VALUE_SCALAR_TYPE_UNSPECIFIED","VALUE_SCALAR_TYPE_TEXT","VALUE_SCALAR_TYPE_NUMBER","VALUE_SCALAR_TYPE_BOOLEAN","VALUE_SCALAR_TYPE_DATETIME","VALUE_SCALAR_TYPE_DATE","VALUE_SCALAR_TYPE_TIME","VALUE_SCALAR_TYPE_FILE","VALUE_SCALAR_TYPE_TIMEDELTA"],"default":"VALUE_SCALAR_TYPE_UNSPECIFIED","description":"- VALUE_SCALAR_TYPE_UNSPECIFIED: Unspecified value type\n - VALUE_SCALAR_TYPE_TEXT: A text value type\n - VALUE_SCALAR_TYPE_NUMBER: A number value type\n - VALUE_SCALAR_TYPE_BOOLEAN: A boolean value type\n - VALUE_SCALAR_TYPE_DATETIME: A datetime value type\n - VALUE_SCALAR_TYPE_DATE: A date value type\n - VALUE_SCALAR_TYPE_TIME: A time value type\n - VALUE_SCALAR_TYPE_FILE: A file value type\n - VALUE_SCALAR_TYPE_TIMEDELTA: A timedelta value type","title":"Supported Value Scalar Types"},"v1ValueOptionalType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a value type that can be optional (nullable)"},"v1ValueListType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a list/array value type containing elements of a specific type"},"v1ValueDictionaryType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this dictionary represents"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueDictionaryTypeField"},"title":"The named fields contained in this dictionary"},"description":{"type":"string","title":"Optional human-readable description of this dictionary type"}},"title":"Represents a dictionary/object value type with named fields"},"v1ValueTableType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this table represents"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueTableTypeColumn"},"title":"The columns that make up this table"},"description":{"type":"string","title":"Optional human-readable description of this table type"}},"title":"Represents a table value type with structured columns"},"v1ValueTableTypeColumn":{"type":"object","properties":{"key":{"type":"string","title":"The name/key of this column"},"value":{"$ref":"#/components/schemas/v1ValueType"},"description":{"type":"string","title":"Optional human-readable description of this column"}},"title":"Represents a single column within a table value type"},"v1ValueOpaqueType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this opaque type represents"},"description":{"type":"string","title":"Optional human-readable description of this opaque type"}},"title":"Represents an opaque value type with semantic meaning but unknown internal structure"},"v1ValueAnyType":{"type":"object","title":"Represents a value type that can hold any kind of value"},"v1ValueUnionType":{"type":"object","properties":{"inners":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueType"},"title":"The possible value types in this union"}},"title":"Represents a union value type that can be one of several possible types"},"v1ValueSensitiveType":{"type":"object","properties":{"inner":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represents a value type that contains sensitive information"},"v1ValueEnumType":{"type":"object","properties":{"is_a":{"type":"string","title":"Semantic classification of what this enum represents"},"members":{"type":"array","items":{"$ref":"#/components/schemas/v1ValueEnumTypeMember"},"title":"The available options/members of this enum"},"description":{"type":"string","title":"Optional human-readable description of this enum type"}},"title":"Represents an enumeration value type with predefined options"},"v1ValueEnumTypeMember":{"type":"object","properties":{"name":{"type":"string","title":"The programmatic name of this enum member"},"description":{"type":"string","title":"Optional human-readable description of this enum member"}},"title":"Represents a single member/option within an enum value type"},"v1ValueGenericDictionaryType":{"type":"object","properties":{"key_type":{"$ref":"#/components/schemas/v1ValueType"},"value_type":{"$ref":"#/components/schemas/v1ValueType"}},"title":"Represent a generic dictionary that can hold any entry of a particular key and value type"},"v1ValueNoneType":{"type":"object","title":"Represents a none value type that can hold no value"},"v1SecretPayload":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/v1SecretPayloadField"}}},"description":"Typed secret payload — one entry per field declared in the secret's\n`SecretType.schema`. Carried over the wire by `AddSecretVersion` and\n`AccessSecretVersion`; gringotts serializes to JSON before persisting."},"v1SecretPayloadField":{"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/commonv1Value"}}},"commonv1Value":{"type":"object","properties":{"null_value":{"type":"string","title":"Represents the absence of a value (None/null/undefined)"},"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"list":{"$ref":"#/components/schemas/v1List"},"dictionary":{"$ref":"#/components/schemas/v1Dictionary"},"file":{"$ref":"#/components/schemas/v1FileValue"},"table":{"$ref":"#/components/schemas/v1TableValue"},"set":{"$ref":"#/components/schemas/v1Set"},"text_value":{"$ref":"#/components/schemas/v1TextValue"},"list_value":{"$ref":"#/components/schemas/commonv1ListValue"},"set_value":{"$ref":"#/components/schemas/v1SetValue"},"dictionary_value":{"$ref":"#/components/schemas/v1DictionaryValue"}},"description":"Represents a runtime value that can be produced by the Jarvis interpreter.\n\nThis message provides a type-safe way to serialize and transmit values between\nthe Jarvis interpreter and other services via gRPC. It supports all the basic\ndata types that can be represented in the Jarvis language runtime.\n\nThe oneof structure ensures that exactly one value type is set at a time,\nproviding both type safety and efficient serialization."},"v1Number":{"type":"object","properties":{"lo":{"type":"integer","format":"int64","description":"Low 32 bits of the 96-bit mantissa."},"mid":{"type":"integer","format":"int64","description":"Middle 32 bits of the 96-bit mantissa."},"hi":{"type":"integer","format":"int64","description":"High 32 bits of the 96-bit mantissa."},"flags":{"type":"integer","format":"int64","description":"Flags word:\n - Bits 16–23: scale (0–28)\n - Bit 31: sign (0 = positive, 1 = negative)\n - Other bits must be zero."}},"description":"A fixed-precision decimal number with up to 28 fractional digits.\n\nThis message represents decimal numbers with exact precision, avoiding\nfloating-point rounding errors. It's particularly useful for financial\ncalculations, measurements, and any scenario where exact decimal\nrepresentation is required.\n\nThe value is calculated as: m / 10^e, where:\n - m is an unsigned 96-bit integer composed of (lo, mid, hi)\n - e is the scale (0–28) stored in flags bits 16–23\n - sign is encoded in flags bit 31 (0 = positive, 1 = negative)\n\nExamples:\n - 123.45 would have m=12345, e=2\n - -0.001 would have m=1, e=3, with sign bit set\n"},"typeDate":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year."},"month":{"type":"integer","format":"int32","description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day."},"day":{"type":"integer","format":"int32","description":"Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant."}},"description":"* A full date, with non-zero year, month, and day values\n* A month and day value, with a zero year, such as an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, such as a credit card expiration\ndate\n\nRelated types are [google.type.TimeOfDay][google.type.TimeOfDay] and\n`google.protobuf.Timestamp`.","title":"Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:"},"typeTimeOfDay":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","description":"Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time."},"minutes":{"type":"integer","format":"int32","description":"Minutes of hour of day. Must be from 0 to 59."},"seconds":{"type":"integer","format":"int32","description":"Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds."},"nanos":{"type":"integer","format":"int32","description":"Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."}},"description":"Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are [google.type.Date][google.type.Date] and\n`google.protobuf.Timestamp`."},"typeDateTime":{"type":"object","properties":{"year":{"type":"integer","format":"int32","description":"Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year."},"month":{"type":"integer","format":"int32","description":"Required. Month of year. Must be from 1 to 12."},"day":{"type":"integer","format":"int32","description":"Required. Day of month. Must be from 1 to 31 and valid for the year and\nmonth."},"hours":{"type":"integer","format":"int32","description":"Required. Hours of day in 24 hour format. Should be from 0 to 23. An API\nmay choose to allow the value \"24:00:00\" for scenarios like business\nclosing time."},"minutes":{"type":"integer","format":"int32","description":"Required. Minutes of hour of day. Must be from 0 to 59."},"seconds":{"type":"integer","format":"int32","description":"Required. Seconds of minutes of the time. Must normally be from 0 to 59. An\nAPI may allow the value 60 if it allows leap-seconds."},"nanos":{"type":"integer","format":"int32","description":"Required. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999."},"utc_offset":{"type":"string","description":"UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }."},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"}},"description":"Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n   day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n   day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n   day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year is 0, the DateTime is considered not to have a specific year. month\nand day must have valid, non-zero values.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations."},"typeTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"IANA Time Zone Database time zone, e.g. \"America/New_York\"."},"version":{"type":"string","description":"Optional. IANA Time Zone Database version number, e.g. \"2019a\"."}},"description":"Represents a time zone from the\n[IANA Time Zone Database](https://www.iana.org/time-zones)."},"v1List":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/commonV1Value"},"title":"The ordered sequence of values in this list"}},"description":"Represents an ordered collection of values (similar to arrays or lists).\n\nThis message can contain any number of Value elements in a specific order.\nLists are mutable and can grow or shrink during runtime. Elements can be\naccessed by their zero-based index position.\n\nExamples:\n - [1, 2, 3] - list of numbers\n - [\"hello\", \"world\"] - list of strings\n - [true, 42, \"mixed\"] - list with mixed types\n - [[1, 2], [3, 4]] - nested lists"},"commonV1Value":{"type":"object","properties":{"null_value":{"type":"string","title":"Represents the absence of a value (None/null/undefined)"},"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"time_zone":{"$ref":"#/components/schemas/typeTimeZone"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"list":{"$ref":"#/components/schemas/v1List"},"dictionary":{"$ref":"#/components/schemas/v1Dictionary"},"file":{"$ref":"#/components/schemas/v1FileValue"},"table":{"$ref":"#/components/schemas/v1TableValue"},"set":{"$ref":"#/components/schemas/v1Set"},"text_value":{"$ref":"#/components/schemas/v1TextValue"},"list_value":{"$ref":"#/components/schemas/commonv1ListValue"},"set_value":{"$ref":"#/components/schemas/v1SetValue"},"dictionary_value":{"$ref":"#/components/schemas/v1DictionaryValue"}},"description":"Represents a runtime value that can be produced by the Jarvis interpreter.\n\nThis message provides a type-safe way to serialize and transmit values between\nthe Jarvis interpreter and other services via gRPC. It supports all the basic\ndata types that can be represented in the Jarvis language runtime.\n\nThe oneof structure ensures that exactly one value type is set at a time,\nproviding both type safety and efficient serialization."},"v1Dictionary":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/v1DictionaryEntry"},"title":"The key-value pairs stored in this dictionary"}},"description":"Represents a key-value mapping (similar to hash maps or dictionaries).\n\nThis message stores associations between keys and values, where keys must be\nhashable types (null, bool, Number, string, Date, TimeOfDay, DateTime, TimeZone). Keys are\nunique within a dictionary - duplicate keys will overwrite previous values.\n\nThe dictionary maintains insertion order for consistent iteration behavior.\n\nExamples:\n - {\"name\": \"John\", \"age\": 30} - string keys with mixed values\n - {1: \"one\", 2: \"two\"} - number keys with string values\n - {\"nested\": {\"inner\": \"value\"}} - nested dictionaries"},"v1DictionaryEntry":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/v1HashableValue"},"value":{"$ref":"#/components/schemas/commonV1Value"}},"description":"Represents a single key-value pair within a Dictionary.\n\nBoth key and value can be any Value type, though keys should be\nhashable types for proper dictionary behavior. Non-hashable keys\n(like lists or dictionaries) may cause runtime errors."},"v1HashableValue":{"type":"object","properties":{"bool_value":{"type":"boolean","title":"Boolean true/false value"},"number":{"$ref":"#/components/schemas/v1Number"},"text":{"type":"string","title":"UTF-8 encoded text string"},"date":{"$ref":"#/components/schemas/typeDate"},"timeofday":{"$ref":"#/components/schemas/typeTimeOfDay"},"datetime":{"$ref":"#/components/schemas/typeDateTime"},"duration":{"type":"string","title":"Signed duration representing a span of time"},"text_value":{"$ref":"#/components/schemas/v1TextValue"}},"description":"Represents a hashable value that can be used as a dictionary key.\n\nThis message contains only the hashable types from the Value message,\ncorresponding to Python's hashable types. These types can be safely\nused as keys in maps and dictionaries.\n\nHashable types include: bool, Number, string, Date, TimeOfDay, DateTime\nand Duration."},"v1TextValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote text content via URL or file path"},"inline":{"type":"string","title":"Text content embedded directly in the message"}},"description":"Represents a text value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling text strings in the Jarvis interpreter:\n- Small strings can be embedded directly using the inline option\n- Large strings can be referenced by URL using the remote option\n- The choice depends on string size, network constraints, and access patterns"},"v1FileValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to a remote file via URL or file path"},"inline":{"$ref":"#/components/schemas/v1File"}},"description":"Represents a file value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling files in the Jarvis interpreter:\n- Small files can be embedded directly using the inline option\n- Large files can be referenced by URL/path using the remote option\n- The choice depends on file size, network constraints, and access patterns"},"v1File":{"type":"object","properties":{"content":{"type":"string","format":"byte","title":"The raw binary content of the file"},"name":{"type":"string","title":"The name of the file, including extension if applicable"}},"description":"Represents a file with its name and binary content.\n\nThis message contains the complete file data including both metadata\n(filename) and the actual file content as raw bytes. It's used for\nembedding files directly within messages when the file size is\nmanageable and immediate access is required.\n\nExamples:\n - Configuration files\n - Small text or binary files\n - Generated reports or documents\n - Temporary files created during execution\n"},"v1TableValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to a remote table via URL or file path (feather-v2 format)"},"inline":{"$ref":"#/components/schemas/v1Table"}},"description":"Represents a table value that can be either stored inline or referenced remotely."},"v1Table":{"type":"object","properties":{"data":{"type":"string","format":"byte","title":"The table data serialized in feather-v2 format"}},"description":"Represents a table with data in feather-v2 format.\n\nThis message contains the complete table data serialized using the\nfeather-v2 format, which provides efficient columnar storage and\nfast serialization/deserialization for tabular data."},"v1Set":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/v1HashableValue"},"title":"The unique elements stored in this set\nAll elements must be hashable types"}},"description":"Represents an unordered collection of unique values.\n\nThis message stores a collection of unique elements, where duplicate values\nare automatically removed. Only hashable types can be stored in sets.\nSets are useful for membership testing, removing duplicates, and mathematical\nset operations like union, intersection, and difference.\n\nThe set does not maintain insertion order - elements may appear in any order\nduring iteration.\n\nExamples:\n - {1, 2, 3} - set of numbers\n - {\"apple\", \"banana\", \"cherry\"} - set of strings\n - {true, false} - set of booleans\n - {1, \"hello\", true} - set with mixed hashable types"},"commonv1ListValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote list data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1List"}},"description":"Represents a list value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large lists:\n- Small lists can be embedded directly using the inline option\n- Large lists can be referenced by URL using the remote option"},"v1SetValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote set data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1Set"}},"description":"Represents a set value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large sets:\n- Small sets can be embedded directly using the inline option\n- Large sets can be referenced by URL using the remote option"},"v1DictionaryValue":{"type":"object","properties":{"remote":{"type":"string","title":"Reference to remote dictionary data via URL or file path"},"inline":{"$ref":"#/components/schemas/v1Dictionary"}},"description":"Represents a dictionary value that can be either stored inline or referenced remotely.\n\nThis message provides flexibility for handling large dictionaries:\n- Small dictionaries can be embedded directly using the inline option\n- Large dictionaries can be referenced by URL using the remote option"}}},"paths":{"/api/v1/secretTypes:validateSchema":{"post":{"summary":"Validate Secret Schema","description":"Validate a typed payload against a schema. Pure check — no stored\nsecret is read, no payload is persisted. Returns `valid = false` plus\nper-field violations on mismatch; never an `INVALID_ARGUMENT` status.","operationId":"ValidateSecretSchema","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ValidateSecretSchemaResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ValidateSecretSchemaRequest"}}},"required":true},"tags":["Secrets"]}}}}
```
