Skip to main content
PATCH
Change access properties of a certificate.

Use Cases

Make a certificate public

In order to make a certificate public, the body property public should be set to true.

Make a certificate private or change the certificate pin

In order to make a certificate private or change the certificate PIN, the body property certificatePin should be passed with the desired PIN.

Change externalId

In order to change the externalId of a certificate, the body property externalId should be passed with the desired externalId.

Delete externalId

In order to delete the externalId of a certificate, the body property externalId should be passed with null.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

type
enum<string>
required

Type of the certificate identifier.

Available options:
certID,
externalId,
fileHash,
hash
id
string
required

Identifier of the certificate.

Example:

"123"

Query Parameters

pin
string

PIN of the certificate (if the certificate is private).

Example:

"1234"

Body

application/json

Data needed to change the access properties of a certificate.

public
boolean

Flag that indicates whether the certificate must be public or not.

Example:

true

certificatePin
string

New PIN of the certificate.

Example:

"1234"

externalId
string

New custom identifier of the certificate.

Example:

"extcertid"

Response

Successful certificate access properties update.

statusCode
integer

Request status code.

Example:

200

message
string

Message returned by the request.

Example:

"Certificate access properties updated"

data
object

Data returned by the request.

Example:

"The access properties of the certificate with certID 'did:<env>:certid:<id>' have been updated."