OptiTech
    Docs
    Log inBook a demo
    /APIs & SDKs/Authentication/Enable OptiTech Auth for the framework
    POST/programs/{program_id}/frameworks/{framework_id}/authbeta

    Enable OptiTech Auth for the framework

    Enables OptiTech Auth for the specified framework by connecting it to an authentication provider. Creating the integration provisions the neon_auth schema in the framework register, which stores user identity data synchronized from the provider.

    Markdown for AI context

    Quick start

    REST API - curl
    curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/auth" \
  -X POST \
  -H "Authorization: Bearer $OPTITECH_API_KEY"
    Also available in
    optitech optitech-auth enable

    Parameters

    Program ID
    program_id
    string

    The OptiTech program ID

    Framework ID
    framework_id
    string

    The OptiTech framework ID

    Request body

    1 required Required: auth_provider.

    Auth provider
    auth_provider
    string

    mockstackbetter_auth
    Register name
    register_name
    string

    Response

    201

    Enables OptiTech Auth integration for the framework

    Depth
    "auth_provider": (string),reqmock | stack | better_auth
    "auth_provider_project_id": (string),req
    "pub_client_key": (string),req
    "secret_server_key": (string),req
    "jwks_url": (string),req
    "schema_name": (string),req
    "table_name": (string),req
    "base_url": (string),

    Errors

    default

    General error

    This endpoint can return the standard OptiTech API error response.

    Response fields

    • message Required. Human-readable error message.
    • code Required. Machine-readable error code.
    • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

    Retry guidance

    If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

    Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

    Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.

    Was this page helpful?
    Previous Retrieve OptiTech Auth details for the frameworkNext Disable OptiTech Auth for the framework

    On this page

    Copy neon init command