OPopenziti
Enroll

Enroll an identity via one-time-token

Changed on

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

post/enroll/updb

Request

Query parameters

tokenstring uuid required

Request body

passwordstring
usernamestring

Response

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

Example response

{
  "data": {
    "controllers": [
      {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "createdAt": "2000-01-23T04:56:07.000+00:00",
        "id": "id",
        "tags": {},
        "updatedAt": "2000-01-23T04:56:07.000+00:00",
        "apiAddresses": null,
        "certPem": "certPem",
        "ctrlAddress": "ctrlAddress",
        "fingerprint": "fingerprint",
        "isOnline": true,
        "isPreferredLeader": true,
        "lastJoinedAt": "2000-01-23T04:56:07.000+00:00",
        "name": "name"
      },
      {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "createdAt": "2000-01-23T04:56:07.000+00:00",
        "id": "id",
        "tags": {},
        "updatedAt": "2000-01-23T04:56:07.000+00:00",
        "apiAddresses": null,
        "certPem": "certPem",
        "ctrlAddress": "ctrlAddress",
        "fingerprint": "fingerprint",
        "isOnline": true,
        "isPreferredLeader": true,
        "lastJoinedAt": "2000-01-23T04:56:07.000+00:00",
        "name": "name"
      }
    ],
    "username": "username"
  },
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

  • f7b51eaafbbbRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to no type for status

    • info

      added subschema #2 to the response property allOf list for the response status

  • 058711718149Revision changes
    • info

      added the non-success response with the status