---
title: "Enroll an identity via one-time-token"
method: POST
path: "/enroll/updb"
tags: ["Enroll"]
---

# Enroll an identity via one-time-token

`POST /enroll/updb`

## Request

- Base URL: `https://demo.ziti.dev/edge/client/v1`
- URL: `https://demo.ziti.dev/edge/client/v1/enroll/updb`
- Auth: none declared
- TypeScript: <https://skmtc.dev/openziti/apis/ziti-edge-client/docs/enroll/updb/post.ts> (a function with typed inputs; its response is checked against the schema)

Enrolls an identity via a one-time-token to establish an initial username and password combination

## Query parameters

- `token` string, uuid, required

## Request body

- EnrollUpdbRequest
  - `password` string
  - `username` string

## Response `200`

A response to a successful username/password enrollment carrying the established username and common enrollment data

- EnrollmentResponseUpdbEnvelope
  - `data` EnrollmentResponseUpdb: Common data returned on any successful enrollment, regardless of method. The controllers field carries the set of controllers in the cluster the enrolling client may connect to.
    - `controllers` ControllerDetail[]: An array of controller resources
      - `_links` object, required: A map of named links
      - `createdAt` string, date-time, required
      - `id` string, required
      - `tags` Tags
      - `updatedAt` string, date-time, required
      - `apiAddresses` ApiAddressList
      - `certPem` string, required
      - `ctrlAddress` string, nullable
      - `fingerprint` string, required
      - `isOnline` boolean, required
      - `isPreferredLeader` boolean
      - `lastJoinedAt` string, date-time, required
      - `name` string, required
    - `username` string: The username established for the enrolled identity
  - `meta` Meta
    - `apiEnrollmentVersion` string
    - `apiVersion` string
    - `filterableFields` string[]
    - `pagination` Pagination
      - `limit` number, required
      - `offset` number, required
      - `totalCount` number, required

## Other responses

- `400`: The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information
- `404`: The requested resource does not exist
- `429`: The resource requested is rate limited and the rate limit has been exceeded
- `503`: The request could not be completed due to the server being busy or in a temporarily bad state

## Changes

- **2026-10-14** `f7b51eaafbbb`: 3 breaking, 1 info
  - the response property `data` became optional for the status `200`
  - the response property `meta` became optional for the status `200`
  - the `data` response's property type changed from `object` to no type for status `200`
  - added `#/components/schemas/enrollmentResponse, subschema #2` to the `data` response property `allOf` list for the response status `200`
- **2025-03-17** `058711718149`: 1 info
  - added the non-success response with the status `400`
- **2025-01-24** `19dfd92f02a2`: 1 info
  - added the non-success response with the status `503`
- **2024-06-07** `26670d8bbc37`: 1 breaking, 1 info
  - added required request body
  - api operation id `ernollUpdb` removed and replaced with `enrollUpdb`
- **2024-05-29** `cce2800c1357`: 1 breaking, 3 warning, 3 info
  - removed the request body
  - the optional response header `WWW-Authenticate` removed for the status `200`
  - the optional response header `WWW-Authenticate` removed for the status `404`
  - the optional response header `WWW-Authenticate` removed for the status `429`
  - …3 more

[Operation history](https://skmtc.dev/openziti/apis/ziti-edge-client/changes/enroll/updb/post.md)

---

[API](https://skmtc.dev/openziti/apis/ziti-edge-client.md) - [All operations](https://skmtc.dev/openziti/apis/ziti-edge-client/llms.txt) - [OpenAPI document](https://skmtc.dev/openziti/apis/ziti-edge-client/revisions/f7b51eaafbbb?raw)