Skip to content

OnePlatform

AuthConfig

Initializing search

aaron777collins/oneplatform

Home
Getting Started
Architecture
Operations
Reference
Development

OnePlatform

aaron777collins/oneplatform

Home
Getting Started
Getting Started
Architecture
Architecture
- Decisions
  Decisions
  - Architecture Decisions
  - Expanded Decisions
- Service Designs
  Service Designs
  - Gateway
  - Auth
  - Ingestion
  - Ontology
  - Pipeline
  - Execution
  - App
  - Logging
  - Plugin
- Package Designs
  Package Designs
  - SDK
  - App SDK
  - Plugin SDK
  - CLI
  - Frontend
- Cross-Cutting
  Cross-Cutting
Operations
Operations
Reference
Reference
- CLI
  CLI
  - app
  - auth
  - completion
  - config
  - connector
  - data
  - dlq
  - exec
  - logs
  - mapping
  - ontology
  - pipeline
  - plugin
  - profile
  - role
  - schedule
  - sdk
  - service
  - status
  - user
  - version
  - webhook-out
- SDK (@oneplatform/sdk)
  SDK (@oneplatform/sdk)
  - Functions
    Functions
    
    createClient
    
    filter
  - Interfaces
    Interfaces
    
    OnePlatformClient
    
    ClientOptions
    
    Pipeline
    
    PipelineRun
    
    ConnectorInstance
    
    Plugin
    
    App
    
    User
    
    ApiKey
    
    Page
    
    PaginatedIterable
    
    ListOptions
    
    FilterBuilder
    
    Subscription
    
    RetryPolicy
  - Error Classes
    Error Classes
    
    OnePlatformError
    
    AuthError
    
    ValidationError
    
    NotFoundError
    
    RateLimitError
- App SDK (@oneplatform/app-sdk)
  App SDK (@oneplatform/app-sdk)
  - Functions
    Functions
    
    AppProvider
    
    useQuery
    
    useMutation
    
    useSubscription
    
    useUser
    
    usePermission
    
    useAppStorage
  - Interfaces
    Interfaces
    
    QueryResult
    
    MutationResult
    
    SubscriptionResult
    
    UserContext
    
    EntityEvent
- Plugin SDK (@oneplatform/plugin-sdk)
  Plugin SDK (@oneplatform/plugin-sdk)
  - Interfaces
    Interfaces
    
    Connector
    
    ConnectorMetadata
    
    Destination
    
    Transformer
    
    Widget
    
    AuthProvider
    
    PluginContext
    
    HookDeclaration
    
    CacheAccessor
    
    CredentialAccessor
  - Error Classes
    Error Classes
    
    PluginError
    
    PluginAuthError
    
    PluginConfigError
    
    PluginDataError
- Core Library (@oneplatform/core)
  Core Library (@oneplatform/core)
  - Functions
    Functions
    
    createApp
    
    createLogger
    
    createDbClient
    
    createRedisClient
    
    createQueue
    
    createWorker
    
    createEventPublisher
    
    createServiceTokenSigner
    
    authMiddleware
    
    serviceAuthMiddleware
    
    corsMiddleware
    
    errorHandlerMiddleware
    
    healthz
    
    loadConfig
    
    encrypt
    
    decrypt
  - Interfaces
    Interfaces
    
    Logger
    
    EventPublisher
    
    ApiResponse
    
    PaginatedResponse
    
    UserContext
    
    ServiceTokenSigner
    
    CreateAppConfig
  - Error Classes
    Error Classes
    
    AppError
    
    ValidationError
    
    NotFoundError
    
    ForbiddenError
    
    UnauthorizedError
    
    RateLimitError
Development
Development
- Development Process
- Working State
- Analysis
  Analysis

@oneplatform/sdk

@oneplatform/sdk / AuthConfig

Type Alias: AuthConfig¶

AuthConfig = ApiKeyAuthConfig | AccessTokenAuthConfig | BrowserAuthConfig

Defined in: packages/sdk/src/types/client-options.ts:61

Made with Material for MkDocs