Sign in

v1

latestOpenAPI 3.0.12026-07-1719674.9 KB
fabric-ca-server

Register a new identity with the Fabric CA server.
An enrollment secret is returned which can then be used, along with the enrollment ID, to enroll a new identity.
The caller must have hf.Registrar authority.

post/api/v1/register

Query parameters

castring

The name of the CA to direct this request to within the server, or the default CA if not specified

Headers

Authorizationstring required

An enrollment token consisting of two base 64 encoded parts separated by a period:

  • an enrollment certificate;
  • a signature over the HTTP method, URL path, request body, and the certificate.

Request body

idstring required

The enrollment ID which uniquely identifies an identity

typestring

The type of the identity (e.g. user, app, peer, orderer, etc)

secretstring

The enrollment secret. If not provided, a random secret is generated.

max_enrollmentsinteger

The maximum number of times that the secret can be used to enroll.
If 0, use the configured max_enrollments of the fabric-ca-server; If > 0 and <= configured max enrollments of the fabric-ca-server, use max_enrollments;
If > configured max enrollments of the fabric-ca-server, error.

affiliationstring

The affiliation of the new identity. If no affliation is provided, the affiliation of the registrar is used.

canamestring

Name of the CA to direct traffic to within server.

Response

Successfully registered identity

{"stackTrail":"components:schemas:responseBase:properties:result","oasType":"schema","type":"unknown"}
successboolean required

Boolean indicating if the request was successful.