TrieOH
IdentityXAPIAuthn

Set up IdentityX

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).

POST/auth/setup

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).

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/setup" \  -H "Content-Type: application/json" \  -d '{    "email": "admin@trieoh.com",    "password": "S3curePassw0rd!"  }'
{
  "code": 200,
  "message": "string",
  "error": {
    "code": "BAD_REQUEST",
    "message": "string",
    "fields": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "meta": {},
    "debug": {
      "raw_error": "string",
      "stack_trace": "string"
    }
  },
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 0,
    "has_next": true,
    "has_prev": true,
    "next_page": 0,
    "prev_page": 0
  },
  "timestamp": "2019-08-24T14:15:22Z",
  "module": "string",
  "data": {
    "access_token": "string",
    "refresh_token": "string",
    "access_expires_at": "2019-08-24T14:15:22Z",
    "refresh_expires_at": "2019-08-24T14:15:22Z",
    "domain": "string"
  }
}
{
  "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"
}

Check if IdentityX is set up GET

Returns 204 while setup is still pending (no first account yet) and 409 once the system has been set up — used by installers to decide whether to show the setup form. Public.

Register a user POST

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`.