Enroll

Enroll an identity via one-time-token with a pre-exchanged client certificate

Changed on

Enroll an identity via a one-time-token that also requires a pre-exchanged client certificate to match a Certificate Authority that has been added and verified (See POST /cas and POST /cas{id}/verify). The client must present a client certificate signed by CA associated with the enrollment. This enrollment is similar to CA auto enrollment except that is required the identity to be pre-created.

As the client certificate has been pre-exchanged there is no CSR input to this enrollment method.

post/enroll/ottca

Request

Request body

clientCsrstring
tokenstring

Response

A response to a successful enrollment that carries no certificates, only common enrollment data such as the list of controllers

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"
      }
    ]
  },
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the optional property / to the response with the status

    • info

      added the non-success response with the status