TrieOH
IdentityXAPIAuthn

Register a user

Registers the credential pair, either as an IdentityX client (no `project_id`) or as a client of a project that consumes IdentityX for authn (pass `project_id`). Returns 201 with an empty body — the caller then logs in via `/auth/login`.

POST/auth/register

Registers the credential pair, either as an IdentityX client (no project_id) or as a client of a project that consumes IdentityX for authn (pass project_id). Returns 201 with an empty body — the caller then logs in via /auth/login.

Query Parameters

project_id?string

Project to scope the operation to. Omit for IdentityX itself.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for /auth/setup, /auth/register, and /auth/login. Mirrors models.IDXRegisterRequest / models.IDXLoginRequest.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/register" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "password": "S3curePassw0rd!"  }'
Empty
{
  "code": 0,
  "message": "string",
  "error": {
    "code": "BAD_REQUEST",
    "message": "string",
    "fields": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "meta": {},
    "debug": {
      "raw_error": "string",
      "stack_trace": "string"
    }
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "module": "IdentityX"
}
{
  "code": 0,
  "message": "string",
  "error": {
    "code": "BAD_REQUEST",
    "message": "string",
    "fields": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "meta": {},
    "debug": {
      "raw_error": "string",
      "stack_trace": "string"
    }
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "module": "IdentityX"
}
{
  "code": 0,
  "message": "string",
  "error": {
    "code": "BAD_REQUEST",
    "message": "string",
    "fields": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "meta": {},
    "debug": {
      "raw_error": "string",
      "stack_trace": "string"
    }
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "module": "IdentityX"
}
{
  "code": 0,
  "message": "string",
  "error": {
    "code": "BAD_REQUEST",
    "message": "string",
    "fields": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "meta": {},
    "debug": {
      "raw_error": "string",
      "stack_trace": "string"
    }
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "module": "IdentityX"
}

Set up IdentityX POST

Creates the first account in the system as a super admin and enables authn. Succeeds only once — subsequent calls return 409 ("setup already complete"). Returns the freshly issued token pair (201).

Verify an email address POST

Redeems the single-use JWT carried by a verification email and marks the actor's email as verified. The token is HMAC-signed, purpose-scoped, expires after a short TTL, and is consumed on first use (jti anti-replay). Re-clicking a consumed link on an already-verified account succeeds (idempotent).