AUTHN API Reference
Module Information
Service Files:
- Private:
service/authn.js - Public:
service/authn.js
Available Services: 1 Documented Services: 1
authn.create
Exchange an HTTP Authorization header credential for a short-lived opaque token. The credential is stored via the authn_store procedure and the generated token is returned to the caller for subsequent authenticated requests.
| Property | Value |
|---|---|
| Scope | Hub (requires hub context) |
| Permission | anyone |
Endpoint:
https://hostname/-/svc/authn.create
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Authorization | string | Yes | - | Standard HTTP Authorization header (e.g. Basic or Bearer scheme). Read from the request header, not the request body. |
Returns
| Field | Type | Description |
|---|---|---|
token | string | 22-character opaque authentication token generated by uniqueId(22) and persisted via the authn_store stored procedure |
Possible Errors
| Error Code | HTTP Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Authorization header is missing or malformed |
INTERNAL_ERROR | 500 | Failed to persist token via authn_store procedure |
Related Documentation
- ACL System - Permission model
- Service Routing - URL patterns
- Error Handling - Error codes