Configuration for custom authentication logic and how it integrates into the OpenAPI spec.
AuthConfig()| Name | Type |
|---|---|
| path | str |
| disable_studio_auth | bool |
| openapi | SecurityConfig |
| cache | CacheConfig |
Required. Path to an instance of the Auth() class that implements custom authentication.
Format: "path/to/file.py:my_auth"
Optional. Whether to disable LangSmith API-key authentication for requests originating the Studio.
Defaults to False, meaning that if a particular header is set, the server will verify the x-api-key header
value is a valid API key for the deployment's workspace. If True, all requests will go through your custom
authentication logic, regardless of origin of the request.
The security configuration to include in your server's OpenAPI spec.
Example (OAuth2): { "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "password": { "tokenUrl": "/token", "scopes": {"me": "Read user info", "items": "Manage items"} } } } }, "security": [ {"OAuth2": ["me"]} ] }
Optional. Cache configuration for the server.