Client Registry via REST API
Last updated
Was this helpful?
Connectware 1.11.0
Last updated
Was this helpful?
The REST API registration method enables advanced client configuration during the registration process. With this method, clients (e.g. agents) can include additional information, such as context details, role requests, permission specifications, and certificate signing requests (CSRs), in their registration payload.
When using certificate signing requests (CSR), the Common Name (CN) in the CSR must match the username in the payload and must not be empty. Otherwise, the request will be rejected.
The REST API client registration follows this workflow:
The client sends an initial registration request to Connectware with credentials and desired permissions (optional).
If the registry endpoint is locked (default status), Connectware returns a "locked" (HTTP status 423) response.
An administrator opens the registry endpoint for five minutes.
The client resends the registration request and receives a "pending" (HTTP status 202) response.
The client must poll by repeating the registration request at regular intervals.
The administrator reviews and explicitly grants the pending registration.
Upon the next poll, the client receives a "granted" (HTTP status 201) response.
For CSR requests, the response includes the signed certificate.
After successful registration, the client can authenticate normally.
