v1

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

Update an existing identity.
The caller must have hf.Registrar authority.

put/api/v1/identities/{id}

Path parameters

idstring required

An enrollment ID

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

typestring

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

secretstring

The new enrollment secret.

max_enrollmentsinteger

The new maximum number of times that the secret can be used to enroll.
If -1, 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 path of the identity.

canamestring

Name of the CA to direct traffic to within server.

Response

Successfully updated identity

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

Boolean indicating if the request was successful.