/APIs & SDKs/Authentication/Create new auth user
POST/programs/{program_id}/frameworks/{framework_id}/auth/usersbeta

Create new auth user

Creates a new user in the OptiTech Auth user directory for the specified framework. The user is created in the neon_auth.users_sync table and can immediately authenticate using the framework's configured auth providers.

Markdown for AI context

Quick start

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

Parameters

Program ID
program_id
string

The OptiTech program ID

Framework ID
framework_id
string

The OptiTech framework ID

Request body

1 required Required: email.

Email
email
string

≥1 chars, ≤256 chars

Name
name
string

≥1 chars, ≤255 chars

Response

201

Creates new user

Depth
"id": (string),req

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?

On this page

Copy neon init command