Enroll
Enroll an identity via one-time-token
Changed onEnroll an identity via a one-time-token which is supplied via a query string parameter. This enrollment method expects a PEM encoded CSRs to be provided for fulfillment. It is up to the enrolling identity to manage the private key backing the CSR request.
post/enroll/ott
Request
- Base URLhttps://demo.ziti.dev/edge/client/v1
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
A response containing and identities client certificate chains
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"
}
],
"ca": "ca",
"cert": "cert",
"serverCert": "serverCert"
},
"meta": {
"apiEnrollmentVersion": "apiEnrollmentVersion",
"apiVersion": "apiVersion",
"filterableFields": [
"filterableFields",
"filterableFields"
],
"pagination": {
"limit": 0.8008281904610115,
"offset": 6.027456183070403,
"totalCount": 1.4658129805029452
}
}
}Changes
- breaking
the
response's property type changed fromobjectto no type for status - warning
removed the optional property
/from the response with the status - warning
removed the optional property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
added
subschema #2to theresponse propertyallOflist for the response status
- breaking
- info
added the non-success response with the status
- info